Xrm.Page.data.process (référence côté client)

 

Date de publication : janvier 2017

S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

L'espace de noms Xrm.Page.data.process contient des événements, des méthodes et des objets à faire interagir avec les données du flux des processus d'entreprise dans un formulaire.

Voir Xrm.Page.ui.process (référence côté client) pour connaître les méthodes permettant d'interagir avec le contrôle du flux des processus d'entreprise dans le formulaire.

Méthodes Xrm.Page.data.process

• Méthodes ActiveProcess
  Utilisez getActiveProcess pour récupérer des informations sur le processus actifs et getActiveProcess pour définir un autre processus en tant que processus actif.

• Méthodes ProcessInstance
  Utilisez getProcessInstances pour récupérer des informations sur toutes les instances de processus d'un enregistrement d'entité et setActiveProcessInstance pour définir une instance de processus comme instance active.

• Méthodes ActiveStage
  Utilisez getActiveStage pour récupérer des informations sur la phase active et getActiveStage pour définir une phase terminée comme phase active.

  Vous pouvez utiliser getActiveStage dans une phase au sein d'une autre entité.

• getActivePath
  Cette méthode visant à obtenir qu'une collection de phases présentes dans le chemin d'accès actif avec les méthodes interagissent avec les phases affichées dans le contrôle de flux des processus d'entreprise.

  Le chemin actif représente les étapes actuellement rendues dans le contrôle du processus en fonction des règles de branchement et des données actuelles de l'enregistrement.

• getEnabledProcesses
  Cette méthode permet de récupérer de manière asynchrone les flux de processus d'entreprise activés auxquels l'utilisateur peut passer pour une entité.

• getSelectedStage
  Utilisez cette méthode pour accéder à la phase sélectionnée actuellement.

• Méthodes pour gérer des gestionnaires d'événements
  Utilisez les méthodes addOnStageChange, removeOnStageChange, addOnStageSelectedremoveOnStageSelected, addOnProcessStatusChange et removeOnProcessStatusChange pour ajouter ou supprimer des gestionnaires d'événements pour le contrôle du flux des processus d'entreprise.

• Méthodes de navigation
  Utilisez moveNext pour passer à la phase suivante et movePrevious à passer à la phase précédente.

  Vous pouvez utiliser movePrevious dans une phase précédente au sein d'une autre entité.

• Méthodes de processus
  Utilisez des méthodes de processus pour accéder aux propriétés du processus.

• Méthodes d'instance
  Utilisez les méthodes d'instance de processus pour accéder aux propriétés de l'instance de processus actuelle.

• Méthodes de la phase
  Utilisez des méthodes de phase pour accéder aux propriétés de la phase dans un flux des processus d'entreprise.

• Méthodes d'étape
  Utilisez des méthodes d'étape pour accéder aux propriétés de l'étape dans un flux des processus d'entreprise.

Méthodes ActiveProcess

Utilisez getActiveProcess pour récupérer des informations sur le processus actifs et getActiveProcess pour définir un autre processus en tant que processus actif.

getActiveProcess

Renvoie un objet de Process représentant le processus actif.

var activeProcess = Xrm.Page.data.process.getActiveProcess();

• Valeur renvoyée
  Type : Processus

  Remarques : Voir Méthodes de processus pour les méthodes permettant d'accéder aux propriétés du processus renvoyé.

getActiveProcess

Définissez un Process comme processus actif.

S'il existe une instance active du processus, l'enregistrement d'entité est chargé avec l'ID de l'instance. S'il n'existe aucune instance active du processus actuel, une nouvelle instance de processus est créée et l'enregistrement d'entité est chargé avec l'ID de l'instance. S'il existe plusieurs instances du processus actuel, l'enregistrement est chargé avec la première instance du processus actif conformément à la logique par défaut, qui est l'instance de processus récemment utilisée par utilisateur.

Xrm.Page.data.process.setActiveProcess(processId, callbackFunction);

Paramètres :

• processId
  Tapez :String

  Remarques : ID du processus permettant de rendre le processus actif.

• callbackFunction
  Type :Function

  Remarques : Fonction à appeler lorsque l'opération est terminée. Cette fonction de rappel reçoit l'une des valeurs de chaîne suivantes pour indiquer si l'opération a réussi.

  Valeur	Description
  success	L'opération a réussi.
  invalid	La valeur processId n'est pas valide ou le processus n'est pas activé.

Méthodes ProcessInstance

Utilisez getProcessInstances pour récupérer des informations sur toutes les instances de processus d'un enregistrement d'entité et setActiveProcessInstance pour définir une instance de processus comme instance active.

getProcessInstances

Renvoie toutes les instances de processus pour l'enregistrement d'entité auquel l'utilisateur appelant a accès.

Xrm.Page.data.process.getProcessInstances(callbackFunction(object));

• Paramètre
  Tapez :Function

  Remarques : un objet est transmis à la fonction de rappel avec les attributs suivants et leurs valeurs correspondantes comme clé : paire de valeurs.

  • CreatedOn

  • ProcessDefinitionID

  • ProcessDefinitionName

  • ProcessInstanceID

  • ProcessInstanceName

  • StatusCodeName

  Les instances de processus sont filtrés selon les privilèges de l'utilisateur.

setActiveProcessInstance

Définit une instance de processus comme instance active.

Xrm.Page.data.process.setActiveProcessInstance(processInstanceId, callbackFunction);

Paramètres :

• processInstanceId
  Tapez :String

  Remarques : ID de l'instance de processus à définir comme instance active.

• callbackFunction
  Tapez :Function

  Remarques : Fonction à appeler lorsque l'opération est terminée. Cette fonction de rappel reçoit l'une des valeurs de chaîne suivantes pour indiquer si l'opération a réussi.

  Valeur	Description
  success	L'opération a réussi.
  invalid	La valeur processInstanceId n'est pas valide ou le processus n'est pas activé.

Méthodes ActiveStage

Utilisez getActiveStage pour récupérer des informations sur la phase active et getActiveStage pour définir une phase différente comme phase active.

getActiveStage

Renvoie un objet de Stage représentant la phase active.

var activeStage = Xrm.Page.data.process.getActiveStage();

• Valeur renvoyée
  Type : Phase

  Remarques : Voir Méthodes de la phase pour les méthodes permettant d'accéder aux propriétés de la phase renvoyée.

getActiveStage

Définissez une phase terminée comme phase active.

Xrm.Page.data.process.setActiveStage(stageId, callbackFunction);

Paramètres :

• stageId
  Type :String

  Remarques : ID de la phase terminée de l'entité à définir en tant que phase active.

• callbackFunction
  Type :Function

  Remarques : fonction facultative à appeler lorsque l'opération est terminée.

  La fonction de rappel se voit transmettre la valeur de chaîne « success » si l'opération réussit.

  Si la valeur stageId représente une phase qui n'est pas valide, la phase ne peut pas devenir active et la fonction de rappel reçoit une valeur de chaîne en indiquant la raison. Les valeurs répertoriées dans le tableau suivant peuvent être renvoyées.

  Valeur	Raison
  invalid	Trois raisons pour lesquelles cette valeur peut être retournée : Le paramètre stageId correspond à une valeur d'ID de phase inexistante. La phase active n'est pas la phase sélectionnée L'enregistrement n'a pas encore été enregistré.
  unreachable	La phase existe sur un autre chemin.
  dirtyForm	Cette valeur sera retournée si les données de la page ne sont pas enregistrées.

  Important

  Cette méthode peut uniquement être utilisée lorsque la phase sélectionnée et la phase active sont identiques. Lorsque votre code est initialisé à partir de l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, la phase actuelle est sélectionnée. Lorsque votre code est initialisé à partir de l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, vous devez utiliser Xrm.Page.data.process.getActiveStage pour vérifier que la phase sélectionnée est également la phase active. Pour tout autre événement de formulaire, il est impossible de déterminer la phase actuellement sélectionnée. Pour de meilleurs résultats, cette méthode ne doit être utilisée que dans le code appelé dans les fonctions initialisées par les événements OnStageChange et OnStageSelected.

getActivePath

Cette méthode visant à obtenir qu'une collection de phases présentes dans le chemin d'accès actif avec les méthodes interagissent avec les phases affichées dans le contrôle de flux des processus d'entreprise.

Le chemin actif représente les étapes actuellement rendues dans le contrôle du processus en fonction des règles de branchement et des données actuelles de l'enregistrement.

var stageCollection = Xrm.Page.data.process.getActivePath();

Exemple :

Voir Exemple : Xrm.Page.data.process.getActivePath pour obtenir un exemple utilisant cette méthode.

• Valeur renvoyée
  Type : Collection

  Remarks: Collection de toutes les phases terminées, de la phase active actuellement et de l'ensemble prévu des futures phases selon des conditions satisfaisantes dans la règle de branchement. Il peut s'agir d'un sous-ensemble de phases renvoyées avec Xrm.Page.data.process.getActiveProcess, car il ne contient que les phases qui représentent une transition valide de la phase actuelle basée sur le branchement qui s'est produit dans le processus.

getEnabledProcesses

Cette méthode permet de récupérer de manière asynchrone les flux de processus d'entreprise activés auxquels l'utilisateur peut passer pour une entité.

Xrm.Page.data.process.getEnabledProcesses(callbackFunction(enabledProcesses));

• Paramètre
  Type :Function

  Remarques : La fonction de rappel doit accepter un paramètre contenant un objet avec des propriétés de dictionnaire, où le nom de la propriété est l'ID du flux des processus d'entreprise et la valeur de la propriété est le nom du flux des processus d'entreprise.

  Les processus activés sont filtrés selon les privilèges de l'utilisateur. La liste des processus activés est est identique à celle qu'un utilisateur peut afficher dans l'interface utilisateur s'il souhaite modifier le processus manuellement.

  Exemple :

  Voir Exemple : Xrm.Page.data.process.getEnabledProcesses pour obtenir un exemple utilisant cette méthode.

getSelectedStage

Utilisez cette méthode pour obtenir la phase sélectionnée actuellement.

Xrm.Page.data.process.getSelectedStage()

• Valeur renvoyée
  Type : Phase

  Phase actuellement sélectionnée.

• Remarques
  Voir Méthodes de la phase pour connaître les méthodes permettant d'accéder aux propriétés de la phase renvoyée.

Méthodes pour gérer des gestionnaires d'événements

Utilisez ces méthodes pour ajouter ou supprimer des gestionnaires d'événements pour le contrôle du flux des processus d'entreprise.

addOnStageChange

Utilisez cette méthode pour ajouter une fonction en tant que gestionnaire d'événements pour l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, afin qu'il soit appelé lorsque la phase du flux des processus d'entreprise change.

Xrm.Page.data.process.addOnStageChange(handler);

• Paramètre
  Type : référence de fonction

  Remarks: La fonction est ajoutée en bas du pipeline du gestionnaire d’événements. Le contexte d’exécution est automatiquement défini pour agir comme le premier paramètre transmis au gestionnaire d’événements. Pour plus d'informations, voir Contexte d'exécution (référence côté client).

  Vous devez utiliser une référence à une fonction nommée plutôt qu'à une fonction anonyme s'il se peut que vous souhaitiez supprimer le gestionnaire d'événements ultérieurement.

removeOnStageChange

Utilisez cette méthode pour supprimer une fonction en tant que gestionnaire d'événements de l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange.

Xrm.Page.data.process.removeOnStageChange(handler);

• Paramètre
  Type : référence de fonction

  Remarks: Si une fonction anonyme est définie à l'aide de la méthode addOnStageChange, elle ne peut pas être supprimée avec cette méthode.

addOnStageSelected

Utilisez cette méthode pour ajouter une fonction en tant que gestionnaire d'événements pour l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, afin qu'il soit appelé lorsqu'une phase du flux des processus d'entreprise est sélectionnée.

Xrm.Page.data.process.addOnStageSelected(handler);

• Paramètre
  Type : référence de fonction

  Remarks: La fonction est ajoutée en bas du pipeline du gestionnaire d’événements. Le contexte d’exécution est automatiquement défini pour agir comme le premier paramètre transmis au gestionnaire d’événements. Pour plus d'informations, voir Contexte d'exécution (référence côté client).

  Vous devez utiliser une référence à une fonction nommée plutôt qu'à une fonction anonyme s'il se peut que vous souhaitiez supprimer le gestionnaire d'événements ultérieurement.

removeOnStageSelected

Utilisez cette méthode pour supprimer une fonction en tant que gestionnaire d'événements de l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected.

Xrm.Page.data.process.removeOnStageSelected(function reference);

• Paramètre
  Type : référence de fonction

  Remarks: Si une fonction anonyme est définie à l'aide de la méthode addOnStageSelected, elle ne peut pas être supprimée avec cette méthode.

addOnProcessStatusChange

Utilisez cette méthode pour ajouter une fonction en tant que gestionnaire d'événements pour l'événement d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnProcessStatusChange, afin qu'il soit appelé lorsque le flux des processus d'entreprise change de statut.

Xrm.Page.data.process.addOnProcessStatusChange(handler);

• Paramètre
  Type : référence de fonction

  Remarks: La fonction est ajoutée en bas du pipeline du gestionnaire d’événements. Le contexte d’exécution est automatiquement défini pour agir comme le premier paramètre transmis au gestionnaire d’événements. Pour plus d'informations, voir Contexte d'exécution (référence côté client).

  Vous devez utiliser une référence à une fonction nommée plutôt qu'à une fonction anonyme s'il se peut que vous souhaitiez supprimer le gestionnaire d'événements ultérieurement.

  Cette méthode a été introduite dans Mise à jour de décembre 2016 pour Dynamics 365 (en ligne et local).

removeOnProcessStatusChange

Utilisez cette méthode pour supprimer une fonction en tant que gestionnaire d'événements pour l'événement d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnProcessStatusChange.

Xrm.Page.data.process.removeOnProcessStatusChange(handler);

• Paramètre
  Type : référence de fonction

  Remarks: Si une fonction anonyme est définie à l'aide de la méthode addOnProcessStatusChange, elle ne peut pas être supprimée avec cette méthode.

  Cette méthode a été introduite dans Mise à jour de décembre 2016 pour Dynamics 365 (en ligne et local).

Méthodes de navigation

Utilisez moveNext pour passer à la phase suivante et movePrevious à passer à la phase précédente. Ces deux méthodes entraînent la survenue de l'd88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange.

moveNext

Progresse à la phase suivante.

Xrm.Page.data.process.moveNext(callbackFunction);

• Paramètre
  Type : Fonction

  Remarques : fonction facultative à appeler lorsque l'opération est terminée. Cette fonction de rappel reçoit l'une des valeurs de chaîne suivantes pour indiquer si l'opération a réussi.

  Valeur	Description
  success	L'opération a réussi.
  crossEntity	La phase suivante concerne une autre entité.
  end	La phase active est la dernière phase du chemin actif.
  invalid	L'opération a échoué car la phase sélectionnée n'est pas identique à la phase active.
  dirtyForm	Cette valeur sera retournée si les données de la page ne sont pas enregistrées.

movePrevious

Revient à la phase précédente. Vous pouvez utiliser movePrevious dans une phase précédente dans une autre entité.

Xrm.Page.data.process.movePrevious(callbackFunction);

• Paramètre
  Type : Fonction

  Remarques : fonction facultative à appeler lorsque l'opération est terminée. Cette fonction de rappel reçoit l'une des valeurs de chaîne suivantes pour indiquer si l'opération a réussi.

  Valeur	Description
  success	L'opération a réussi.
  crossEntity	La phase précédente concerne une autre entité.
  beginning	La phase active est la première phase du chemin actif.
  invalid	L'opération a échoué car la phase sélectionnée n'est pas identique à la phase active.
  dirtyForm	Cette valeur sera retournée si les données de la page ne sont pas enregistrées.

Méthodes de processus

Un processus contient les données d'un flux des processus d'entreprise. Utilisez les méthodes de processus pour accéder aux propriétés du processus.

getId

Renvoie l'identificateur unique du processus.

var processId = procObj.getId();

• Valeur renvoyée
  Type :String

Remarques La valeur représente la chaîne d'une valeur du GUID.

getName

Renvoie le nom du processus

var processName = procObj.getName();

• Valeur renvoyée
  Type :String

getStages

Renvoie une collection de phases au processus

var stageCollection = procObj.getStages();

• Valeur renvoyée
  Type : Collection

  Voir Méthodes de la phase pour connaître les méthodes permettant d'accéder aux propriétés des phases renvoyées.

isRendered

Renvoie « true » si le processus est affiché, sinon « false »

var processRendered = procObj.isRendered();

• Valeur renvoyée
  Type :Boolean

  Remarques : si le formulaire utilisé a été mis à niveau depuis une version précédente de Microsoft Dynamics 365 et non pour utiliser des formulaires, le contrôle du flux des processus d'entreprise ne peut pas être affiché.Pour plus d'informations :TechNet : Mise à jour de vos formulaires vers Microsoft Dynamics CRM 2013 ou Microsoft Dynamics CRM Online, automne 2013

Méthodes d'instance

Une instance de processus contient les données d'une instance du flux des processus d'entreprise. Utilisez les méthodes pour accéder aux propriétés de l'instance de processus.

getInstanceId

Renvoie l'identificateur unique de l'instance de processus.

Xrm.Page.data.process.getInstanceId();

• Valeur renvoyée
  Tapez :String

Remarques La valeur représente la chaîne d'une valeur du GUID.

getInstanceName

Renvoie le nom de l'instance de processus.

Xrm.Page.data.process.getInstanceName();

• Valeur renvoyée
  Tapez :String

getStatus

Renvoie le statut actuel de l'instance de processus.

Xrm.Page.data.process.getStatus();

• Valeur renvoyée
  Tapez :String

  Remarques : cette méthode renverra une des valeurs suivantes : active, aborted ou finished.

setStatus

Définit le statut actuel de l'instance de processus active.

Xrm.Page.data.process.setStatus(status, callbackFunction);

Paramètres :

• status
  Tapez :String

  Remarques : les valeurs peuvent être active, aborted ou finished.

• callbackFunction
  Tapez :Function

  Remarques : fonction facultative à appeler lorsque l'opération est terminée. Le nouveau statut est transmis à cette fonction de rappel en tant que valeur de chaîne.

Méthodes de la phase

Une phase contient les données d'une phase du flux des processus d'entreprise. Utilisez les méthodes pour accéder aux propriétés de la phase.

getCategory

Renvoie un objet avec une méthode getValue qui renvoie la valeur entière de la catégorie du flux des processus d'entreprise.

var stageCategoryNumber = stageObj.getCategory().getValue();

• Valeur renvoyée
  Type :Number

  Remarques : Pour obtenir la liste des valeurs possibles, voir afe17a4a-fdca-44b4-8c14-a19ba327662e#BKMK_StageCategory.

getEntityName

Renvoie le nom logique de l'entité à laquelle la phase est associée.

var stageEntityName = stageObj.getEntityName();

• Valeur renvoyée
  Type :String

getId

Renvoie l'identificateur unique de la phase.

var stageId = stageObj.getId();

• Valeur renvoyée
  Type :String

getName

Renvoie le nom de la phase.

var stageName = stageObj.getName();

• Valeur renvoyée
  Type :String

getStatus

Renvoie le statut de la phase

var stageStatus = stageObj.getStatus();

• Valeur renvoyée
  Type :String

  Remarques : Cette méthode renvoie active ou inactive.

getSteps

Renvoie une collection d'étapes de la phase.

var stepsCollection = stageObj.getSteps();

• Valeur renvoyée
  Type :Array

  Voir Méthodes d'étape pour connaître les méthodes permettant d'accéder aux valeurs de propriété de l'étape.

Méthodes d'étape

Une étape contient les données d'une étape du flux des processus d'entreprise. Utilisez les méthodes pour accéder aux propriétés de l'étape.

getAttribute

Renvoie le nom logique de l'attribut à laquelle l'étape est associée.

var stepAttributeName = stepObj.getAttribute();

• Valeur renvoyée
  Type :String

  Remarques : Certaines étapes ne contient aucune valeur d'attribut.

getName

Renvoie le nom de l'étape.

var stepName = stepObj.getName();

• Valeur renvoyée
  Type :String

isRequired

Renvoie si l'étape est requise dans le flux des processus d'entreprise.

var stepIsRequired = stepObj.isRequired();

• Valeur renvoyée
  Type :Boolean

  Remarques : Renvoie true si l'étape est marquée comme requise dans l'éditeur de flux des processus d'entreprise ; sinon, false. Il n'existe aucune connexion entre cette valeur et les valeurs que vous pouvez modifier dans les méthodes 6881e99b-45e4-4552-8355-2eef296f2cd8#BKMK_RequiredLevel de l'attribut Xrm.Page.data.entity.

Voir aussi

Écriture d'événements pour les flux de processus d'entreprise
Xrm.Page.ui.process (référence côté client)
Référence par programmation côté client
Référence rapide des scripts de formulaires
Écrire du code pour les formulaires Microsoft Dynamics 365
Utiliser le modèle d’objet Xrm.Page
Exemple : Xrm.Page.data.process.getEnabledProcesses
Exemple : Xrm.Page.data.process.getActivePath

Microsoft Dynamics 365

© 2017 Microsoft. Tous droits réservés. Copyright