GlideFlow : client

L’API GlideFlow fournit des méthodes pour les interactions côté client avec des actions, des flux et des flux secondaires.

Vous pouvez utiliser cette API partout dans la plateforme qui accepte les scripts clients. L’action, le flux ou le flux secondaire doit être défini comme pouvant être appelé par le client et disposer d’une ACL valide à l’aide de la fonction Gérer la sécurité dans Studio de workflow.

Certaines des méthodes de l’API GlideFlow renvoient des objets de promesse . Une promesse représente le résultat final d’une opération asynchrone. Pour plus d’informations sur les promesses, consultez la documentation Promise - Javascript MDN ou AngularJS.

À l’aide de cette API, vous pouvez :

• Démarrez des actions, des flux ou des flux secondaires via un script.
• Obtenir une exécution existante.
• Obtenez l’état et toutes les sorties disponibles.
• Attendez l’achèvement d’une action, d’un flux ou d’un flux secondaire.

Il n’existe aucun constructeur pour l’API GlideFlow . Accédez aux méthodes GlideFlow à l’aide de l’objet global GlideFlow .

GlideFlow : execution.awaitCompletion()

Renvoie un objet de complétion pour l’exécution.

Tableau 1. Paramètres

Nom	Type	Description
Aucun

Tableau 2. Renvoie

Type	Description
Objet	Objet contenant les détails d’achèvement d’un flux ou de l’exécution d’une action.

Dans cet exemple, une action est exécutée à l’aide de startAction(), qui renvoie un objet d’exécution. Le code utilise ensuite awaitCompletion() sur cet objet d’exécution, qui renvoie un objet completion. Le code utilise cet objet de complétion pour consigner l’état et les sorties au sein de l’exécution.

(function() {
	var inputs = {};

	inputs['input1'] = 'string input'; // String

	GlideFlow.startAction('global.action_name', inputs)
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {
			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();

GlideFlow : execution.getExecutionStatus()

Renvoie une chaîne contenant le statut d’exécution de l’exécution actuelle.

Tableau 3. Paramètres

Nom	Type	Description
Aucun

Tableau 4. Renvoie

Type	Description
Chaîne	Chaîne contenant l’état d’exécution.

Dans cet exemple, le code obtient un objet d’exécution à l’aide de la méthode getExecution. La méthode getExecution nécessite un ID, qui est renvoyé par la méthode utilisée pour démarrer l’exécution. Le code utilise ensuite getExecutionStatus() pour déterminer si l’exécution a été terminée avant de continuer.

// Get an existing action, getStatus, and getOutputs if complete
(function() {
   GlideFlow.getExecution('mamIN4Q35vmEFe744EwJV5GHrSz8fmJG')
      .then(function(execution) {
         execution.getExecutionStatus().then(
            function(status) {
               if (status === 'COMPLETE')
                  execution.getOutputs().then(
                     function(outputs) {
                        console.log(outputs);
                     },
                     errorResolver
                  );
            },
            errorResolver
         );
      }, errorResolver);

   function errorResolver(error) {
      // Handle errors in error resolver
      console.error(error);
   }
})();

GlideFlow : execution.getOutputs()

Renvoie un objet de sorties pour l’exécution.

Utilisez cette méthode pour accéder à la sortie générée par l’exécution d’une action, d’un flux ou d’un flux secondaire.

Tableau 5. Paramètres

Nom	Type	Description
Aucun

Tableau 6. Renvoie

Type	Description
Objet	Objet contenant des sorties pour une action, un flux ou un flux secondaire.

Dans cet exemple, le code obtient un objet d’exécution à l’aide de la méthode getExecution. Une fois l’exécution terminée, le code utilise getOutputs() pour renvoyer un objet de sorties, qu’il journalise ensuite à l’aide de la méthode console.log.

// Get an existing action, getStatus, and getOutputs if complete
(function() {
   GlideFlow.getExecution('mamIN4Q35vmEFe744EwJV5GHrSz8fmJG')
      .then(function(execution) {
         execution.getExecutionStatus().then(
            function(status) {
               if (status === 'COMPLETE')
                  execution.getOutputs().then(
                     function(outputs) {
                        console.log(outputs);
                     },
                     errorResolver
                  );
            },
            errorResolver
         );
      }, errorResolver);

   function errorResolver(error) {
      // Handle errors in error resolver
      console.error(error);
   }
})();

GlideFlow : getExecution(String executionId)

Obtenir une instance d’exécution existante par ID.

Tableau 7. Paramètres

Nom	Type	Description
executionId	Chaîne	L’ID de l’exécution à récupérer.

Tableau 8. Renvoie

Type	Description
Objet	Promesse d’un objet d’exécution.

Dans cet exemple, le code obtient une exécution, puis attend qu’elle soit terminée avant d’enregistrer l’état d’achèvement des exécutions et les sorties à l’aide de console.log.

// Get an existing action and await completion
(function() {
	GlideFlow.getExecution('79cd437e0b202300a150a95e93673ae3')
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {

			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();

GlideFlow : startAction(String scopedName.actionName, entrées de carte)

Démarrez une action.

Tableau 9. Paramètres

Nom	Type	Description
nom du champ d’application	Chaîne	Nom inclus dans le périmètre du flux à exécuter.
entrées	Objet	Objet contenant des entrées définies pour l’action.

Tableau 10. Renvoie

Type	Description
Objet	Objet contenant des détails sur l’exécution de l’action.

Dans cet exemple, le code démarre l’action de action_name globale à l’aide d’arguments dans la variable d’objet d’entrée des entrées. Une fois l’opération terminée, l’exemple utilise console.log ou console.error pour signaler la réussite ou l’échec du flux.

// Start an action and await completion.
(function() {
	var inputs = {};

	inputs['input1'] = 'string input'; // String

	GlideFlow.startAction('global.action_name', inputs)
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {
			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();

GlideFlow : startFlow(String scopedName.flowName, entrées de carte)

Démarrez un flux.

Tableau 11. Paramètres

Nom	Type	Description
nom du champ d’application	Chaîne	Nom inclus dans le périmètre du flux à exécuter.
entrées	Objet	Objet contenant des entrées définies pour le flux.

Tableau 12. Renvoie

Type	Description
Objet	Objet contenant des détails sur l’exécution du flux.

Cet exemple de flux est normalement déclenché lorsqu’un enregistrement de la table d’incidents est mis à jour. Étant donné que vous activez le flux à partir du script client, vous devez fournir ces informations. Le code crée une variable d’entrées qui contient l’enregistrement actuel et la table de l’enregistrement

// Start a Flow
(function() {
      var inputs = {};
      inputs['current'] = { // GlideRecord 
        table : 'incident', 
        sys_id : '79cd437e0b202300a150a95e93673ae3'  
    };
        inputs['table_name'] = 'incident';
         GlideFlow.startFlow('global.flow_name', inputs)
		.then(
			function(execution) {
				console.log('Started flow_name with execution id :' + execution.getExecutionId());
			},
			function(error) {
				console.log('Unable to start flow: ' + error);
			}
		);
})();

GlideFlow : startSubflow(Chaîne scopedName.subflowName, entrées de carte)

Démarrer un flux secondaire.

Tableau 13. Paramètres

Nom	Type	Description
nom du champ d’application	Chaîne	Nom inclus dans le périmètre du flux à exécuter.
entrées	Objet	Objet contenant des entrées utilisées pour le flux secondaire.

Tableau 14. Renvoie

Type	Description
Objet	Objet contenant des détails sur l’exécution du flux secondaire.

Dans cet exemple, le code démarre le flux secondaire de subflow_name global à l’aide d’arguments dans la variable de tableau d’entrées. Une fois l’opération terminée, l’exemple utilise console.log ou console.error pour signaler la réussite ou l’échec du flux.

// Start an action and await completion.
(function() {
	var inputs = {};

	inputs['input1'] = 'string input'; // String

	GlideFlow.startSubflow('global.subflow_name', inputs)
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {
			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();