Ausgabeparameter

Allgemeine Ausgabeparameter

Folgende Ausgabeparameter werden immer interpretiert:

Key	Datentyp	Value
Message	string, string[]	die anzuzeigende Meldung bzw. Meldungen für mehrere Zeilen
MessageType	string	der Typ der Meldung. Dieser wird ignoriert, wenn der Parameter Message nicht angegeben ist. Folgende Werte werden unterstützt: Information: Meldung wird als Information dargestellt Warning: Meldung wird als Warnung dargestellt Error: Meldung wird als Fehler dargestellt Ist kein Wert oder ein ungültiger Wert angegeben, so wird Information verwendet.
MessageCaption	string	eine Überschrift für die Message
Html	Dictionary <string,object>	enthält die Daten für das Anzeigen einer HTML-Meldung als Modalen Dialog
Files	Dictionary <string,object>	ein Array von Datei-Definitionen
ModalSizeClass	string	die Größe des anzuzeigenden Dialoges, die auch für die HTML-Prompts als Größe verwendet wirdy erlaubte Werte: „s“ – Small „m“ – Medium „l“ – Large „xl“ – Extra Large „flex“ – Flex
Logs	Dictionary<string, object>[]	Ein Array von Log-Definitionen

Html

Das können die Inhalte der HTML-Meldung sein:

Key	Datentyp	Value
Content	string	die HTML Meldung
Height (optional)	int	die Höhe des Bereichs, in welchem die Meldung angezeigt wird
Width (optional)	int	die Weite des Bereichs, in welchem die Meldung angezeigt wird

Files

Das können die Inhalte der Dateien sein:

Key	Datentyp	Value
FileName	string	der Dateiname zur Anzeige und zur Ermittlung des Dateityps
Content	string	der Base64 kodierte Dateiinhalt

Dateibeispiel

public Dictionary<string, object> Execute(Dictionary<string, object> parameter)
{
    return new Dictionary<string, object>()
    {
        {
            "Files",
            new [] {
                new Dictionary<string, object>
                {
                    {"FileName", "datei1.jpg" },
                    {"Content", "<BASE64STRING>" }
                },
                new Dictionary<string, object>
                {
                    {"FileName", "datei2.mpg" },
                    {"Content", "<BASE64STRING>" }
                }
            }
        }
    };
}

Einschränkungen

Die Darstellung von Dateien kann nicht von allen Aktionen unterstützt werden.

Bitte entsprechenden Hinweis an der jeweiligen Aktion beachten.

Logs

Das können die Inhalte der Logs sein:

Key	Datentyp	Value
LogCode	string	Ein 5 Zeichen langer Fehlercode
LogMessage	string	Eine Fehlermeldung, welche in die Ereignisanzeige geschrieben werden soll

Dateibeispiel

public Dictionary<string, object> Execute(Dictionary<string, object> parameter)
{
    return new Dictionary<string, object>()
    {
        {
            "Logs",
            new [] {
                new Dictionary<string, object>
                {
                    {"LogCode", "00000" },
                    {"LogMessage", "Zieltabelle nicht gefunden" }
                },
                new Dictionary<string, object>
                {
                    {"LogCode", "80000" },
                    {"LogMessage", "Kunde nicht gefunden" }
                }
            }
        }
    };
}

Individuelle Dialog-Formulare

Zudem hast du die Möglichkeit, einen Dialog zu öffnen, das der Benutzer dann bearbeiten kann. Dazu musst du keine eigene HTML-Seite hosten. (s. Individuelle Dialog-Formulare)

Wichtig

Damit deine HTML-Meldung sich der Optik von Salesware angleicht, kannst du auf eine öffentlich zur Verfügung stehende CSS zugreifen. Du findest diese unter https://salesware.cloud/api/asset/{{client-id}}/style.css. Die interne {{client-id}} kannst du von deinem Salesware-Partner erfahren.

Entity-Spezifische Ausgabeparameter

Folgende Ausgabeparameter stehen nur in spezifischen Entität/Aktionen zur Verfügung:

Key	Datentyp	Value
Custom	Dictionary <string,object>	Das Custom-Feld (einer Position) einer Entität Als Key dient der Sage-Identifier des Feldes (Klassenname.Datenbankspalte) (z.B. VKBeleg.USER_Zahlungsreferenz)

Der Aufbau der Custom-Felder entspricht folgendem Schema:

{
  "contact": {
    "Tabellenname.Spaltenname": "Wert"
  }
}

Potentiell unterstützt werden alle Entitäten, welche Custom-Felder als Eingabeparameter unterstützen.

Aktuell wird nicht jeder Auslöser unterstützt, da reine Lese-Zugriffe keine Daten manipulieren und somit eine Rückgabe nicht gespeichert wird, z.B. die Auslöser dynamicColumnInitializatio0n oder manually.

Funktions-spezifische Ausgabeparameter

siehe Individuelle Dialog-Formulare