formContext.data.process (référence de l’API client)

  • Article

Fournit des événement, des méthodes et des objets pour interagir avec les données du flux des processus d’entreprise dans un formulaire. Voir formContext.ui.process (référence de l’API client) pour obtenir des méthodes permettant d’interagir avec le contrôle de flux des processus d’entreprise sur le formulaire.

Événements de processus et méthodes de gestionnaire d’événements

Utilisez les événements et les méthodes de gestionnaire d’événements suivants pour écrire des scripts pour les flux des processus d’entreprise.

Event Méthodes du gestionnaire d’événements
OnPreProcessStatusChange addOnPreProcessStatusChange
removeOnPreProcessStatusChange
OnProcessStatusChange addOnProcessStatusChange
removeOnProcessStatusChange
Événement OnPreStageChange addOnPreStageChange
removeOnPreStageChange
OnStageChange addOnStageChange
removeOnStageChange
OnStageSelected addOnStageSelected
removeOnStageSelected

Méthodes de processus actif

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

Nom Description
getActiveProcess Renvoie un objet de Processus représentant le processus actif.
setActiveProcess Définit un Processus comme processus actif.

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.

Nom Description
getId Renvoie l’identificateur unique du processus.
getName Renvoie le nom du processus.
getStages Renvoie un ensemble de phases dans le processus.
isRendered Renvoie une valeur booléenne indiquant si le processus est rendu ou non.

Méthodes ProcessInstance

Utilisez ces méthodes pour récupérer des informations sur toutes les instances de processus d’un enregistrement et pour définir une instance de processus comme instance active.

Nom Description
getProcessInstances Renvoie toutes les instances de processus pour l’enregistrement de table auquel l’utilisateur appelant a accès.
setActiveProcessInstance Définit une instance de processus comme instance active.

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.

Nom Description
getInstanceId Renvoie l’identificateur unique de l’instance de processus.
getInstanceName Renvoie le nom de l’instance de processus.
getStatus Renvoie le statut actuel de l’instance de processus.
setStatus Définit le statut actuel de l’instance de processus active.

Méthodes de phase active

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

Nom Description
getActiveStage Renvoie un objet de Phase représentant la phase active.
setActiveStage Définit une phase terminée comme phase active.

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.

Nom Description
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.
getEntityName Renvoie le nom logique de la table associée à l’étape.
getId Renvoie l’identificateur unique de la phase.
getName Renvoie le nom de la phase.
getNavigationBehavior Renvoie un objet de comportement de navigation pour une étape qui peut être utilisé pour indiquer si le bouton Créer permet aux utilisateurs de créer un autre enregistrement de table dans un scénario de navigation de flux des processus d’entreprise croisé.
getStatus Renvoie le statut de la phase.
getSteps Renvoie une collection d’étapes de la phase.

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.

Nom Description
getAttribute Renvoie le nom logique de la colonne associée à l’étape.
getName Renvoie le nom de l’étape.
getProgress Renvoie la progression de la mesure.
isRequired Renvoie une valeur booléenne indiquant si l’étape est requise dans le flux des processus d’entreprise ou non.
setProgress Met à jour la progression de la mesure.

Utilisez ces méthodes pour aux phases précédentes et suivantes. Ces deux méthodes génèreront l’événement OnStageChange.

Nom Description
moveNext Progresse à la phase suivante.
movePrevious Revient à la phase précédente.

Autres méthodes utiles

Utilisez ces méthodes pour trouver des informations sur les phases dans le chemin d’accès actif, les processus activés et la phase sélectionnée.

Nom Description
getActivePath Obtient 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.
getEnabledProcesses Récupère de manière asynchrone les flux des processus d’entreprise activés pour une table vers laquelle l’utilisateur actuel peut basculer.
getSelectedStage Obtient la phase actuellement sélectionnée.

formContext.ui.process (référence de l’API client)
Comprendre le modèle d’objet Xrm
Contrôles (référence de l’API client)

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).