This repository has been archived by the owner on Jan 28, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from salesforce-flowpro/node-docs
feat: add docs for nodes
- Loading branch information
Showing
9 changed files
with
1,036 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| <p>Erstellt eine Tabelle mithilfe einer Vorlage</p> | ||
|
|
||
| <h3>Eingaben</h3> | ||
| <dl class="message-properties"> | ||
| <dt class="required"> | ||
| payload | ||
| <span class="property-type">Array von Objekten</span> | ||
| </dt> | ||
| <dd> | ||
| Die Daten, die verwendet werden, um die Zeilen zu erstellen. Jedes Objekt im | ||
| Array stellt eine Tabellenzeile dar, und jeder Schlüssel des Objekts ist | ||
| eine Spalte der Tabelle. | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| Daten | ||
| <span class="property-type">string</span> | ||
| </dt> | ||
| <dd> | ||
| Das Feld, das verwendet wird, um die Daten zum Erstellen der Tabelle zu | ||
| bestimmen. Wenn | ||
| <code>msg.data</code> | ||
| nicht existiert, werden die Zeilenwerte aus | ||
| <code>msg.payload</code> | ||
| verwendet. Der Wert, der mit | ||
| <code>msg.data</code> | ||
| festgelegt wird, hat Vorrang gegenüber dem Wert im Formular der | ||
| Node-Eigenschaften und | ||
| <code>msg.payload</code> | ||
| . | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| templateFilepath | ||
| <span class="property-type">String</span> | ||
| </dt> | ||
| <dd> | ||
| Der lokale Dateipfad zu einer | ||
| <code>.xlsx | .xls</code> | ||
| -Vorlage. Der Wert, der mit | ||
| <code>msg.templateFilepath</code> | ||
| festgelegt wird, hat Vorrang vor dem im Eigenschaftsformular des Knotens | ||
| eingestellten Wert. | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| templateSheetName | ||
| <span class="property-type">String</span> | ||
| </dt> | ||
| <dd> | ||
| Der Name des Tabellenblatts, das aus der Vorlage verwendet werden soll. Der | ||
| Wert, der mit | ||
| <code>msg.templateSheetName</code> | ||
| festgelegt wird, hat Vorrang vor dem im Eigenschaftsformular des Knotens | ||
| eingestellten Wert. | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| outputFilepath | ||
| <span class="property-type">String</span> | ||
| </dt> | ||
| <dd> | ||
| Der lokale Dateipfad, um die generierte | ||
| <code>.xlsx | .xls</code> | ||
| -Datei zu speichern. Der Wert, der mit | ||
| <code>msg.outputFilepath</code> | ||
| festgelegt wird, hat Vorrang vor dem im Eigenschaftsformular des Knotens | ||
| eingestellten Wert. | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h3>Ausgaben</h3> | ||
| <ol class="node-ports"> | ||
| <li> | ||
| Ausgabepfad | ||
| <dl class="message-properties"> | ||
| <dt> | ||
| payload | ||
| <span class="property-type">String</span> | ||
| </dt> | ||
| <dd>Der Pfad, unter dem die generierte Datei gespeichert wurde.</dd> | ||
| </dl> | ||
| </li> | ||
| </ol> | ||
|
|
||
| <h3>Details</h3> | ||
|
|
||
| <p> | ||
| Das folgende Beispiel zeigt den Payload, der an den Knoten gesendet werden | ||
| soll. Jedes Objekt im Array entspricht einer Zeile, und wenn eine Spalte leer | ||
| ist, sollten Sie einen leeren String übergeben. | ||
| </p> | ||
|
|
||
| <pre><code> | ||
| msg.payload = [ | ||
| { | ||
| "column-1" : "wert", | ||
| "column-2" : "wert", | ||
| "column-3" : "wert" | ||
| }, | ||
| { | ||
| "column-1" : "wert", | ||
| "column-2" : "", | ||
| "column-3" : "wert" | ||
| } | ||
| ] | ||
| </code></pre> | ||
|
|
||
| <p> | ||
| Wenn Sie eine der Knoten-Eigenschaften überschreiben müssen, legen Sie diese | ||
| einfach im | ||
| <code>msg</code> | ||
| -Objekt fest, wie im folgenden Beispiel gezeigt. | ||
| </p> | ||
|
|
||
| <pre><code> | ||
| msg = { | ||
| "payload": [ | ||
| { | ||
| "column-1" : "wert", | ||
| "column-2" : "wert", | ||
| "column-3" : "wert" | ||
| }, | ||
| { | ||
| "column-1" : "wert", | ||
| "column-2" : "", | ||
| "column-3" : "wert" | ||
| } | ||
| ], | ||
| "templateFilepath": "meine-vorlage.xlsx", | ||
| "templateSheetName": "mein blattname", | ||
| "outputFilepath": "ausgabe.xlsx" | ||
| } | ||
| </code></pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <p>Configures a safe connection with a Salesforce Org</p> | ||
|
|
||
| This config node can be used to safely configure a connection with Salesforce using a Connected App. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| <p>Cria uma planilha usando um modelo</p> | ||
|
|
||
| <h3>Entradas</h3> | ||
| <dl class="message-properties"> | ||
| <dt class="required"> | ||
| payload | ||
| <span class="property-type">array de objetos</span> | ||
| </dt> | ||
| <dd> | ||
| os dados usados para criar as linhas. Cada objeto no array representa uma | ||
| linha da planilha. E cada chave do objeto corresponde a uma coluna da | ||
| planilha. | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| dados | ||
| <span class="property-type">string</span> | ||
| </dt> | ||
| <dd> | ||
| O campo utilizado para definir os dados usados para renderizar a planilha. | ||
| Quando | ||
| <code>msg.data</code> | ||
| não existe, os valores das linhas vêm de | ||
| <code>msg.payload</code> | ||
| . O valor definido usando | ||
| <code>msg.data</code> | ||
| tem precedência sobre o valor definido no formulário de propriedades do nó e | ||
| <code>msg.payload</code> | ||
| . | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| templateFilepath | ||
| <span class="property-type">string</span> | ||
| </dt> | ||
| <dd> | ||
| o caminho local para um arquivo de modelo | ||
| <code>.xlsx | .xls</code> | ||
| . O valor definido usando | ||
| <code>msg.templateFilepath</code> | ||
| tem precedência sobre o valor definido no formulário de propriedades do nó. | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| templateSheetName | ||
| <span class="property-type">string</span> | ||
| </dt> | ||
| <dd> | ||
| o nome da planilha a ser usada a partir do modelo. O valor definido usando | ||
| <code>msg.templateSheetName</code> | ||
| tem precedência sobre o valor definido no formulário de propriedades do nó. | ||
| </dd> | ||
|
|
||
| <dt class="optional"> | ||
| outputFilepath | ||
| <span class="property-type">string</span> | ||
| </dt> | ||
| <dd> | ||
| o caminho local para armazenar o arquivo gerado | ||
| <code>.xlsx | .xls</code> | ||
| . O valor definido usando | ||
| <code>msg.outputFilepath</code> | ||
| tem precedência sobre o valor definido no formulário de propriedades do nó. | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h3>Saídas</h3> | ||
| <ol class="node-ports"> | ||
| <li> | ||
| Caminho do Arquivo de Saída | ||
| <dl class="message-properties"> | ||
| <dt> | ||
| payload | ||
| <span class="property-type">string</span> | ||
| </dt> | ||
| <dd>o caminho onde o arquivo gerado foi salvo.</dd> | ||
| </dl> | ||
| </li> | ||
| </ol> | ||
|
|
||
| <h3>Detalhes</h3> | ||
|
|
||
| <p> | ||
| O exemplo a seguir demonstra o payload a ser enviado para o nó. Cada objeto | ||
| dentro do array corresponde a uma linha, e se uma coluna estiver vazia, você | ||
| deve passar uma string vazia. | ||
| </p> | ||
|
|
||
| <pre><code> | ||
| msg.payload = [ | ||
| { | ||
| "column-1" : "valor", | ||
| "column-2" : "valor", | ||
| "column-3" : "valor" | ||
| }, | ||
| { | ||
| "column-1" : "valor", | ||
| "column-2" : "", | ||
| "column-3" : "valor" | ||
| } | ||
| ] | ||
| </code></pre> | ||
|
|
||
| <p> | ||
| Se você precisar sobrescrever qualquer uma das propriedades do nó, basta | ||
| defini-las no | ||
| <code>msg</code> | ||
| conforme mostrado abaixo. | ||
| </p> | ||
|
|
||
| <pre><code> | ||
| msg = { | ||
| "payload": [ | ||
| { | ||
| "column-1" : "valor", | ||
| "column-2" : "valor", | ||
| "column-3" : "valor" | ||
| }, | ||
| { | ||
| "column-1" : "valor", | ||
| "column-2" : "", | ||
| "column-3" : "valor" | ||
| } | ||
| ], | ||
| "templateFilepath": "meu-modelo.xlsx", | ||
| "templateSheetName": "nome da minha planilha", | ||
| "outputFilepath": "saida.xlsx" | ||
| } | ||
| </code></pre> |
Oops, something went wrong.