ScriptableFlowRunnerResult : Bereichsbezogen

Erfasst das Ergebnis der Verwendung von ScriptableFlowRunner zum Ausführen eines Flows, Subflows 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-Bezeichner sn_fd.

API-Aufrufreihenfolge

Zum Erstellen und Ausführen von Flows, Subflows und Aktionen verwenden Sie diese APIs in der folgenden Reihenfolge:

1. FlowAPI: Erstellt ein Generatorobjekt

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

2. ScriptableFlowRunner: Geben Sie den auszuführenden Inhalt Workflow-Studio an

Verwenden Sie diese Methoden in der folgenden Reihenfolge, um das Builder-Muster zu erstellen:

1. Verwenden Sie eine der Methoden action(), datastream(), flow()oder subflow(), um anzugeben, welcher Typ von Workflow-Studio -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 Workflow-Studio Ausführungsdetails ab

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

Beispiel

In diesem Beispiel wird gezeigt, wie Sie ein ScriptableFlowRunner-Generator-Objekt erstellen und damit eine Genehmigungsaktion für einen bestimmten Datensatz ausfü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 – debuggen ()

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

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 2. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Ausführungsdetails zur Aktion, zum Flow oder zur Ausführung von Workflow-Studio. Flow-Objektname: Name des Flows, Subflows 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: Für die Ausführung benötigte Zeit. Kontext-ID: Sys_id des Ausführungsdetail-Datensatzes Workflow-Studio für die Aktion, den Flow oder den Subflow. Ausgabeanzahl: Anzahl der Aktions- oder Subflow-Ausgaben.

In diesem Beispiel wird gezeigt, wie Informationen zum ausgeführten Flow, Subflow oder zur 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

ScriptableFlowRunnerResult – getContextId()

Gibt die Kontext-ID des Flows, Subflows oder der Aktion zurück.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

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

In diesem Beispiel wird gezeigt, wie eine Kontext-ID aus einem ScriptableFlowRunnerResult-Objekt abgerufen wird.

var contextId = result.getContextId();

Ausgabe:

4ecead85c4da1110598d0c7d6bf73554

ScriptableFlowRunnerResult – getDate()

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

Tabelle : 5. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 6. Ergebnisse

Typ	Beschreibung
GlideDateTime	Datum und Uhrzeit der Ausführung des Flows, Subflows oder der Aktion.

In diesem Beispiel wird gezeigt, 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 Methode datastream() in der Builder-Klasse ScriptableFlowRunner verwendet wurde, gibt diese den Datenstrom als ScriptableDataStream-Objekt zurück. Verwenden Sie die Klasse ScriptableDataStream, um Elemente im Stream zu durchlaufen. Siehe ScriptableDataStream.

Weitere Informationen zu Datenstromaktionen finden Sie unter Datenstromaktionen und Paginierung.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 8. Ergebnisse

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

In diesem Beispiel wird gezeigt, wie ein Datenstrom aus einem ScriptableFlowRunnerResult-Objekt abgerufen wird.

var datastream = result.getDataStream();

ScriptableFlowRunnerResult – getDomainId()

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

Tabelle : 9. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 10. Ergebnisse

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

In diesem Beispiel wird gezeigt, 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 – getFlowObjectType()

Gibt den Typ der Workflow-Studio -Objektausführung zurück.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 12. Ergebnisse

Typ	Beschreibung
FlowObjectType	Der Typ der Workflow-Studio -Objektausführung, entweder Aktion, Flow oder Subflow.

In diesem Beispiel wird gezeigt, 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 Umfang und den internen Namen der Workflow-Studio -Aktions-, Flow- oder Subflow-Ausführung zurück.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 14. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Umfang und interner Name der Aktion, des Flows oder des Subflows Workflow-Studio, die ausgeführt werden. Beispiel: global.emailflow.

In diesem Beispiel wird gezeigt, wie Sie den Namen des Flows, des Subflows oder der Aktion aus einem ScriptableFlowRunnerResult-Objekt abrufen.

(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 – getOutputs()

Gibt die Ausgaben einer abgeschlossenen Workflow-Studio -Aktion, eines Flows oder eines Subflows zurück.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 16. Ergebnisse

Typ	Beschreibung
Objekt	Objekt, das die Ausgabe einer abgeschlossenen Workflow-Studio -Aktion, eines Flows oder eines Subflows enthält.

In diesem Beispiel wird gezeigt, wie die Ausgaben einer Aktion, eines Flows oder eines Subflows Workflow-Studio mit der ScriptableFlowRunner -API abgerufen 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.