Individuelle Dialog-Formulare

Erklärung

Salesware bietet mit den Prompts die Möglichkeit für bestimmte manuell ausgelöste Aktionen weitere Parameter per Dialog vom Benutzer für die Ausführung der Aktion zu erfragen. Diese Parameter werden dann mit in die Aktionsausführung gegeben und können dort verarbeitet werden.

Möchte man derartige Parameter vom Benutzer abfragen, so gibt man an einer beliebigen Stelle im Code eine Antwort mit einem Prompt-Ausgabeparameter (siehe unten) zurück. In diesem Prompt wird unter anderem die HTML-Darstellen des anzuzeigenden Dialogs definiert. Salesware wird darauf hin einen Dialog anzeigen. Dieses HTML muss ein JSON-Object mit den gewünschten Parametern zusammenstellen und zum Abschluss an einen window.postMessage schicken (siehe Beispiele unten). Salesware wird daraufhin erneut die Aktion aufrufen, jedoch werden die Daten des Prompts als Eingabeparameter (siehe unten) mit übergeben. Mit den übergebenen Prompt-Daten ist es nun möglich in der Aktionsausführung die Stelle, die zuvor die Daten per Ausgabeparameter angefordert hat, zu überspringen. Dazu dient der Name des Prompt, der hier zur Identifizierung genutzt werden kann. Im weiteren Aktionsverlauf können die Parameter dann genutzt und verarbeitet werden.

So lassen sich auch beliebig viele Dialoge auf Wizard-Art dynamisch hintereinander anzeigen.

WICHTIG

Mit diesem Aufruf können Sie das Prompt-Fenster schließen und es findet kein weiterer Aktionsaufruf statt:
window.parent.postMessage({message: 'entityActionPromptAbort'})

Funktions-spezifische Eingabeparameter

Folgende, funktions-spezifische Eingabeparameter werden übergeben:

Key	Datentyp	Value
Prompt	Dictionary<string,object>	enthält die Daten eines HTML-Dialogs, der weitere Parameter anhand der Eingabe des Benutzers abgeholt hat
PreviousPrompts	Dictionary<string, object>[]	Enthält die Daten von vorherigen HTML-Dialogen dieser Aktion

Diese Inhalte sind jeweils im Dictionary enthalten:

Key	Datentyp	Value
Name	string	der Name des Prompts
Data	Dictionary<string, object>	die Daten des HTML-Dialogs

Funktions-spezifische Ausgabeparameter

Nachfolgende, funktions-spezifische Ausgabeparameter werden in Salesware verarbeitet:

Key	Datentyp	Value	Unterstützte Funktionen
Prompt	Dictionary<string, object>	enthält die Daten für einen HTML-Dialog, der angezeigt werden soll, um weitere Parameter abzufragen	Artikel-Aktion, Beleg-Aktion, Kunden-Aktion, Warenkorb-Aktion, Erweiterte Position-Neuberechnung, HTML-Aktion lediglich bei manueller Ausführung auch bei Ausführung vor und nach Bestätigung

Diese Inhalte werden im Dictionary erwartet:

Key	Datentyp	Value
Html	string	der HTML-Code, der im iFrame angezeigt wird
Name	string	der Name des Prompts

Beispiele

Beispiel für Prompt-Aktionen mit einem Prompt

Codebeispiel

using System.Collections.Generic;
using System.Linq;
 
namespace Custom.TestAssembly.HtmlPromptAction
{
    internal class Example
    {
        private const string PreviousPrompts = "PreviousPrompts";
 
        public Dictionary<string, object> Execute(Dictionary<string, object> parameter)
        {
 
            if (!parameter.ContainsKey(PreviousPrompts)
                || (parameter[PreviousPrompts] is List<Dictionary<string, object>> previousPrompts
                && (previousPrompts == null ||
                !previousPrompts.Any(prompt => prompt["Name"].ToString() == "HtmlPromptAction"))))
            {
 
                return new Dictionary<string, object>
                {
                    {
                        "Prompt", new Dictionary<string, object>()
                        {
                            {"Name", "HtmlPromptAction"},
                            {"Html", @"<!DOCTYPE html>
    <html>
      <head>
        <link rel='stylesheet' href='https://edev.4sellers.de/api/asset/64331/style.css' />
      </head>
      <body>
        <script>
            function onClickHandler() {
                var firstName = document.getElementById('fname').value;
                var lastName = document.getElementById('lname').value;
 
                window.parent.postMessage({message: 'entityActionPromptData', value: { fname: firstName, lname: lastName } }, '*');
            }
 
            function abort() {
                window.parent.postMessage({
                    message: 'entityActionPromptAbort'
                });
            }       
        </script>
          <h2>HTML Forms</h2>
          <form>
            <div class='form-group'>
              <label for='fname'>First name:</label><br>
              <input class='form-control' type='text' id='fname' name='fname' value='John'><br>
            </div>
            <div class='form-group'>
              <label for='lname'>Last name:</label><br>
              <input class='form-control' type='text' id='lname' name='lname' value='Doe'><br><br>
            </div>
              <button class='btn btn-primary' onclick='onClickHandler()'>Submit</button>
              <button class='btn btn-primary' onclick='abort()'>Abort</button>
          </form>
      </body>
    </html>"
                            }
                        }
                    }
                };
            }
 
            var promptData = (Dictionary<string, object>) parameter["Prompt"];
            var message = new List<string>();
            if(promptData != null)
            {
                message.Add("Hello World");
                message.Add($"Name: {promptData["Name"]}");
 
                var data = (Dictionary<string, object>) promptData["Data"];
 
                if(data != null)
                {
                    foreach(var kvp in data)
                    {
                        message.Add($"{kvp.Key}: {kvp.Value}");
                    }
                }
            }
 
 
            return new Dictionary<string, object>
                {
                    { "Message", message.ToArray() },
                    { "MessageType", "Information" },
                };
        }
    }
}

Beispiel für Prompt-Aktionen mit mehr als einem Prompt