getActivePath (référence de l’API client)
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.
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.
Syntaxe
var stageCollection = formContext.data.process.getActivePath();
Valeur renvoyée
Type : Collection.
Description : 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 formContext.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.
Exemple
La fonction de Sdk.formOnLoad utilise la méthode formContext.data.process.getActivePath pour extraire une collection de phases. Ensuite, l’exemple de code utilise la méthode forEach de la collecte pour effectuer une boucle à chaque phase. Le code écrit ensuite les propriétés clés de la phase sur la console à l’aide de la fonction Sdk.writeToConsole définie dans cette bibliothèque. Le code accède ensuite à une collection d’étapes pour chaque étape à l’aide de la méthode getSteps. Enfin, l’exemple utilise la méthode forEach de collection d’étapes pour accéder à chaque étape et écrire les propriétés clés de l’étape sur la console.
Notes
La fonction Sdk.formOnLoad de l’exemple de bibliothèque JavaScript doit être définie en tant que gestionnaire d’événement OnLoad pour un formulaire, et la case à cocher Transmettre le contexte d’exécution comme premier paramètre doit être activée dans la boîte de dialogue Propriétés du gestionnaire.
En outre, cet exemple illustre uniquement l’utilisation de certaines des méthodes dans l’API formContext.data.process . Il ne représente l’utilisation de cette API afin de satisfaire une exigence de l’entreprise ; il a uniquement pour objet d’illustrer de quelle manière les valeurs de propriété clés sont accessibles par code.
// A namespace defined for SDK sample code
// You should define a unique namespace for your libraries
var Sdk = window.Sdk || {};
(function () {
// A function to log messages while debugging only
this.writeToConsole = function (message) {
if (typeof console != 'undefined')
{ console.log(message); }
};
// Code to run in the OnLoad event
this.formOnLoad = function (executionContext) {
// Retrieve the formContext
var formContext = executionContext.getFormContext();
// Enumerate the stages and steps in the active path
var activePathCollection = formContext.data.process.getActivePath();
activePathCollection.forEach(function (stage, n) {
Sdk.writeToConsole("Stage Index: " + n);
Sdk.writeToConsole("Table: " + stage.getEntityName());
Sdk.writeToConsole("StageId: " + stage.getId());
Sdk.writeToConsole("Status: " + stage.getStatus());
var stageSteps = stage.getSteps();
stageSteps.forEach(function (step, i) {
Sdk.writeToConsole(" Step Name: " + step.getName());
Sdk.writeToConsole(" Step Column: " + step.getAttribute());
Sdk.writeToConsole(" Step Required: " + step.isRequired());
Sdk.writeToConsole(" ---------------------------------------")
})
Sdk.writeToConsole("---------------------------------------")
});
};
}).call(Sdk);
Lorsque l’exemple s’exécute dans le navigateur, vous pouvez utiliser les outils de développement du navigateur pour afficher le texte écrit sur la console. Par exemple, lorsque cet exemple est exécuté dans le formulaire Opportunité avec le processus de vente d’opportunité, ce qui suit est écrit dans la console :
Stage Index: 0
Table: opportunity
StageId: 6b9ce798-221a-4260-90b2-2a95ed51a5bc
Status: active
Step Name: Identify Contact
Step Column: parentcontactid
Step Required: false
---------------------------------------
Step Name: Identify Account
Step Column: parentaccountid
Step Required: false
---------------------------------------
Step Name: Purchase Timeframe
Step Column: purchasetimeframe
Step Required: false
---------------------------------------
Step Name: Estimated Budget
Step Column: budgetamount
Step Required: false
---------------------------------------
Step Name: Purchase Process
Step Column: purchaseprocess
Step Required: false
---------------------------------------
Step Name: Identify Decision Maker
Step Column: decisionmaker
Step Required: false
---------------------------------------
Step Name: Capture Summary
Step Column: description
Step Required: false
---------------------------------------
---------------------------------------
Stage Index: 1
Table: opportunity
StageId: 650e06b4-789b-46c1-822b-0da76bedb1ed
Status: inactive
Step Name: Customer Need
Step Column: customerneed
Step Required: false
---------------------------------------
Step Name: Proposed Solution
Step Column: proposedsolution
Step Required: false
---------------------------------------
Step Name: Identify Stakeholders
Step Column: identifycustomercontacts
Step Required: false
---------------------------------------
Step Name: Identify Competitors
Step Column: identifycompetitors
Step Required: false
---------------------------------------
---------------------------------------
Stage Index: 2
Table: opportunity
StageId: d3ca8878-8d7b-47b9-852d-fcd838790cfd
Status: inactive
Step Name: Identify Sales Team
Step Column: identifypursuitteam
Step Required: false
---------------------------------------
Step Name: Develop Proposal
Step Column: developproposal
Step Required: false
---------------------------------------
Step Name: Complete Internal Review
Step Column: completeinternalreview
Step Required: false
---------------------------------------
Step Name: Present Proposal
Step Column: presentproposal
Step Required: false
---------------------------------------
---------------------------------------
Stage Index: 3
Table: opportunity
StageId: bb7e830a-61bd-441b-b1fd-6bb104ffa027
Status: inactive
Step Name: Complete Final Proposal
Step Column: completefinalproposal
Step Required: false
---------------------------------------
Step Name: Present Final Proposal
Step Column: presentfinalproposal
Step Required: false
---------------------------------------
Step Name: Confirm Decision Date
Step Column: finaldecisiondate
Step Required: false
---------------------------------------
Step Name: Send Thank You
Step Column: sendthankyounote
Step Required: false
---------------------------------------
Step Name: File De-brief
Step Column: filedebrief
Step Required: false
---------------------------------------
---------------------------------------
Articles associés
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é).