ScriptableFlowRunnerResult – Scoped

Erfasst das Ergebnis der Verwendung von ScriptableFlowRunner zum Ausführen eines Flow, Subflow oder einer Aktion. Enthält Daten wie die Kontext-ID, die Domäne und alle Ausgaben der Flow-Ausführung.

Verwenden Sie diese Methoden in Ihren serverseitigen Skripts mit dem Namespace-Identifier sn_fd.

API-Aufruf Reihenfolge

Erstellen Sie Flows, Subflows und Aktionen mit diesen APIs in der folgenden Reihenfolge, und führen Sie sie aus:

1. FlowAPI: Erstellt ein Generatorobjekt

Verwenden Sie getRunner(), um das ScriptableFlowRunner-Builder-Objekt zu instanziieren.

2. ScriptableFlowRunner: Geben Sie Flow Designer Inhalt an, der ausgeführt werden soll

Verwenden Sie diese Methoden in der folgenden Reihenfolge, um das Generatormuster zu erstellen:

1. Verwenden Sie eine der Methoden action(), datastream(), flow()oder subflow(), um anzugeben, welcher Typ von Flow Designer -Objekt erstellt werden soll.
2. Verwenden Sie eine oder mehrere Methoden wie addInput(), inDomain()oder quick(), um Ausführungsparameter anzugeben.
3. Verwenden Sie die Methode run(), um die Aktion, den Flow oder den Subflow mit den angegebenen Parametern auszuführen und ein ScriptableFlowRunnerResult-Objekt zurückzugeben.

3. ScriptableFlowRunnerResult: Ruft Flow Designer Ausführungsdetails ab

Verwenden Sie eine oder mehrere Methoden wie getContextId(), getOutputs()und getDomainId(), um Ausführungsdetails anzuzeigen.

Beispiel

Dieses Beispiel zeigt, wie ein ScriptableFlowRunner-Generator-Objekt erstellt und verwendet wird, um eine Genehmigungsaktion für einen bestimmten Datensatz auszuführen. Ein ScriptableFlowRunnerResult-Objekt erfasst die Ausführungsargumente und Aktionsausgaben.

(function() {
  try {

    var inputs = {}; 

    inputs['sys_id'] = '57af7aec73d423002728660c4cf6a71c';  // Pass the record's sys_id in as input.  

    var result = sn_fd.FlowAPI.getRunner()  // Create a ScriptableFlowRunner builder object.
      .action('global.markapproved')        // Run the global scope action named markapproved.
      .inForeground()
      .inDomain('TOP/ACME')                 // Run the action from the TOP/ACME domain.                               
      .withInputs(inputs)
      .run();                               // Run the action and return a FlowRunnerResult object.

    var contextId = result.getContextId();  // Retrieve the context ID from the result
    var dateRun = result.getDate();
    var domainUsed = result.getDomainId();  // Retrieve the Domain ID from the result.
    var flowName = result.getFlowObjectName();
    var flowObjectType = result.getFlowObjectType();

    var outputs = result.getOutputs();            // Retrieve any outputs from the action execution.
    var newApprovalStatus = outputs['approval'];  // Echo back the approval status for verification.
		
  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }
	
})();
   

ScriptableFlowRunnerResult – getOutputs()

Gibt die Ausgaben einer abgeschlossenen Flow Designer -Aktion, eines Flow oder eines Subflow zurück.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 2. Ergebnisse

Typ	Beschreibung
Objekt	Objekt, das die Ausgabe einer abgeschlossenen Flow Designer -Aktion, eines Flow oder eines Subflow enthält.

Dieses Beispiel zeigt, wie die Ausgaben einer Flow Designer -Aktion, eines Flow oder eines Subflow abgerufen werden, die mit der ScriptableFlowRunner -API ausgeführt werden.

(function() {
  try {

    var result = sn_fd.FlowAPI.getRunner()
      .action('global.test_action')
      .inForeground()
      .timeout(12000)
      .run();

    gs.info(result.getOutputs());

  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }

})();

Ausgabe:

Flow Designer: Warning. This is an important log message. 

ScriptableFlowRunnerResult – getFlowObjectType()

Gibt den Typ des ausgeführten Objekts Flow Designer zurück.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

Typ	Beschreibung
FlowObjectType	Der Typ der Objektausführung Flow Designer, entweder Aktion, Flow oder Subflow.

Dieses Beispiel zeigt, wie der Flow-Objekttyp aus der ScriptableFlowRunnerResult -API abgerufen wird.

(function() {
  try {

    var result = sn_fd.FlowAPI.getRunner()
      .flow('global.test_flow')
      .inForeground()
      .timeout(12000)
      .run();

    gs.info(result.getFlowObjectType());

  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }

})();

Ausgabe:

flow

ScriptableFlowRunnerResult – getFlowObjectName()

Gibt den Bereich und den internen Namen der ausgeführten Aktion, Flow oder Subflow Flow Designer zurück.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 6. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Der Bereich und der interne Name der ausgeführten Aktion, des Flows oder Subflows Flow Designer. Beispiel: global.emailflow.

Dieses Beispiel zeigt, wie der Name des Flow, Subflow oder Aktionsname aus einem ScriptableFlowRunnerResult-Objekt abgerufen wird.

(function() {
  try {

    var result = sn_fd.FlowAPI.getRunner()
      .flow('global.test_flow')
      .inForeground()
      .timeout(12000)
      .run();

    gs.info(result.getFlowObjectName());

  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }

})();

Ausgabe:

global.test_flow

ScriptableFlowRunnerResult – getDomainId()

Gibt die sys_id der Domäne zurück, in der die Aktion, der Flow oder der Subflow Flow Designer ausgeführt wurde.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 8. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Die sys_id der Domäne, in der die Aktion, der Flow oder der Subflow Flow Designer ausgeführt wurde.

Dieses Beispiel zeigt, wie eine Domänen-ID aus einem ScriptableFlowRunnerResult-Objekt abgerufen wird.

(function() {
  try {

    var result = sn_fd.FlowAPI.getRunner()
      .flow('global.test_flow')
      .inForeground()
      .inDomain('TOP/ACME')
      .timeout(12000)
      .run();

    gs.info(result.getDomainId());

  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }

})();

Ausgabe:

4ecead85a4da1110598d0c7d6bf75554

ScriptableFlowRunnerResult – getDate()

Gibt das Datum und die Uhrzeit zurück, zu denen eine Aktion, ein Flow oder ein Subflow Flow Designer als GlideDateTime-Objekt ausgeführt wurde.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 10. Ergebnisse

Typ	Beschreibung
GlideDateTime	Ausführungsdatum und -uhrzeit für den Flow, Subflow oder die Aktion.

Dieses Beispiel zeigt, wie Datum und Uhrzeit einer Flow-Ausführung aus einem ScriptableFlowRunnerResult-Objekt abgerufen werden.

(function() {
  try {

    var result = sn_fd.FlowAPI.getRunner()
      .flow('global.test_flow')
      .inForeground()
      .timeout(12000)
      .run();

    gs.info(result.getDate());

  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }

})();

Ausgabe:

2020-05-22 18:45:42

ScriptableFlowRunnerResult – getDataStream()

Gibt den Datenstrom aus einer Datenstromaktion zurück.

Wenn die datastream()- Methode in der ScriptableFlowRunner -Generator-Klasse verwendet wurde, gibt diese den Datenstrom als ScriptableDataStream-Objekt zurück. Verwenden Sie die ScriptableDataStream -Klasse, um Elemente im Stream zu durchlaufen. Siehe ScriptableDataStream.

Weitere Informationen zu Datenstromaktionen finden Sie unter Datenstromaktionen und Paginierung.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 12. Ergebnisse

Typ	Beschreibung
ScriptableDataStream	Ein ScriptableDataStream-Objekt, mit dem Sie Elemente in einem Datenstrom durchlaufen können. Verwenden Sie die Methoden in der ScriptableDataStream -Klasse, um mit diesem Objekt zu interagieren. Siehe ScriptableDataStream.

Dieses Beispiel zeigt, wie ein Datenstrom aus einem ScriptableFlowRunnerResult-Objekt abgerufen wird.

var datastream = result.getDataStream();

ScriptableFlowRunnerResult – getContextId()

Gibt die Kontext-ID des Flow, Subflow oder der Aktion zurück.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 14. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Die sys_id des Ausführungsdetail-Datensatzes Flow Designer für die Aktion, den Flow oder den Subflow.

Dieses Beispiel zeigt, wie eine Kontext-ID aus einem ScriptableFlowRunnerResult-Objekt abgerufen wird.

var contextId = result.getContextId();

Ausgabe:

4ecead85c4da1110598d0c7d6bf73554

ScriptableFlowRunnerResult – debug()

Gibt Informationen über den ausgeführten Flow, Subflow oder die Aktion zurück, einschließlich Kontext-ID, Domänen-ID und Ausführungsausgaben.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 16. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Ausführungsdetails zur Aktions-, Flow- oder Subflow-Ausführung Flow Designer. Flow-Objektname: Name des Flow, Subflow oder der Aktion. Flow-Objekttyp: Flow, Subflow, Aktion oder Datenstromaktion. Domänen-ID: ID der Domäne, in der der Flow, Subflow oder die Aktion ausgeführt wurde. Ergebniszeit: Zeit, die für die Ausführung benötigt wurde. Kontext-ID: Sys_id des Ausführungsdetail-Datensatzes Flow Designer für die Aktion, den Flow oder den Subflow. Ausgabeanzahl: Anzahl der Aktions- oder Subflow-Ausgaben.

Dieses Beispiel zeigt, wie Informationen über den ausgeführten Flow, Subflow oder die Aktion aus dem ScriptableFlowRunnerResult-Objekt abgerufen werden.

(function() {
  try {

    var result = sn_fd.FlowAPI.getRunner()
      .flow('global.test_flow')
      .inForeground()
      .timeout(12000)
      .run();

    gs.info(result.debug());

  } catch (ex) {
    var message = ex.getMessage();
    gs.error(message);
  }

})();

Ausgabe:

*** Script: FlowRunnerResult
Flow Object Name: global.test_flow
Flow Object Type: flow
Domain: null
Result Time: 2020-06-08 18:28:41
ContextId: null
Output count: 0