Zum Inhalt springen Zur Hauptnavigation springen Zur Fußzeile springen

Eingabeparameter

Allgemeine Eingabeparameter

Alle Parameter für die Aktion werden im Methoden-Parameter übergeben. Folgende Parameter stehen immer zur Verfügung:

KeyDatentypValue
ClientSagede.OfficeLine.Engine.Mandantdas Mandanten-Objekt
CultureIdstringdie ID der beim Salesware-Benutzer hinterlegten Lokalisierung / Oberflächensprache
LocationKeystringder technische Schlüssel des Standortes, den der Salesware-Benutzer aktuell verwendet
ManuallyTriggeredEntityDictionary<string, object>der EntityIdentifier für die auslösende Sub-Entität
TriggeredBystringder Trigger, welcher die Aktion ausgelöst hat
UserDictionary<string, object>die Benutzerdaten des angemeldeten Benutzers (crm) oder Business-Logins (reseller)
SaleswareClientIdstringdie Client-Id des Salesware-Clients

Der EntityIdentifier wiederum beinhaltet folgende Elemente:

KeyDatentypValue
Entity­Typestringder Typ der auslösenden Sub-Entität, z. B. Position
EntityKeystringder Salesware-Key für diesen Datensatz

Diese Daten werden für den angemeldeten Benutzer oder Business-Login übergeben:

KeyDatentypValueHinweis
Namestringder Name
FirstNamestringder Vorname
UserAccountTypestringder Kontotyp (crm | reseller)
EMailstringdie E-Mailadresse
CustomerNumberstringdie Kundennummer des zugehörigen Kundennur bei Business-Logins (reseller)
UserGroupsstring[]ein Array der technischen Schlüssel der zugeordneten Benutzergruppen (bei Benutzern) oder der zugeordneten Business-Login-Gruppen (bei Business-Logins)
ErpRepresentativestringder technische Schlüssel des hinterlegten ERP Vertretersnur bei Benutzern (crm)
ErpUserstringder Name des hinterlegten ERP-Benutzersnur bei Benutzern (crm)

In einigen Aktionen stehen auch Positionsdaten zur Verfügung. Das sind immer folgende Daten:

KeyDatentypValue
EntityKeystringder Salesware-Key für diesen Datensatz
ItemNumberstringdie Artikelnummer
VariationIdintdie interne Variantennummer (AuspraegungID)
Quantitydecimaldie Menge
QuantityTypeshortdie Mengenart
QuantityUnitstringdie Mengeneinheit
UnitPricedecimalder Einzelpreis
DiscountValuedecimalder Rabattsatz (in Prozent)
IsManualPricebooldas Kennzeichen, ob der Einzelpreis manuell verändert worden ist (EinzelpreisManuell)
Wichtig
WICHTIG

Wenn in einer Aktion zusätzliche Daten übergeben werden, ist das in der Aktion selbst beschrieben.

Entity-Spezifische Eingabeparameter

Folgende Parameter stehen nur in ausgewählten Entitäten zur Verfügung:

KeyDatentypValue
ExternalEntityReferencestringDie Salesware-Referenznummer für diese Entität
Das Format ist abhängig von der Konfiguration in den Salesware-Einstellungen
(z.B. DFFC4C71-63E5-4625-83DC-FD937DB3F7C1)

Die Salesware-Referenz zur Position, bei ans ERP übergebenen Positionen die BelPosId
CustomDictionary<string,object>Das Custom-Feld einer Entität
Als Key dient der Sage-Identifier des Feldes (Klassenname.Datenbankspalte)
(z.B. VKBeleg.USER_Zahlungsreferenz)

Das Custom-Feld einer Position in einer Entität
(z.B. VKBelegPositionen.USER_extern)
FilesDictionary<string,object>[]das Array von Datei-Definitionen mit der Möglichkeit zum Downloaden via URL

Das können die Inhalte der Files sein:

KeyDatentypValue
FileNamestringder Dateiname zur Anzeige und zur Ermittlung des Dateityps
PermanentUrlstringURL zum Download der Datei, die beim externen Aufruf eine Autorisierung benötigt und permanent gültig ist

Wir empfehlen diese, wenn ein Benutzer oder Business-Login im Browser die Datei herunterladen möchte.
TemporaryUrlstringURL zum Download der Datei, die keine Autorisierung benötigt und ab Start der Aktion für 15 Minuten gültig ist

Wir empfehlen diese zum Abruf einer Datei im Rahmen einer Aktion.

Dateibeispiel

public Dictionary<string, object> Execute(Dictionary<string, object> parameter)
{
    return new Dictionary<string, object>()
    {
        {
            "Files",
            new [] {
                new Dictionary<string, object>
                {
                    {"FileName", "datei1.jpg" },
                    {"PermanentUrl", "https://url-to-Salesware.cloud/PermanentUrl" },
                    {"TemporaryUrl", "https://url-to-Salesware.cloud/TemporaryUrl" }
                },
                new Dictionary<string, object>
                {
                    {"FileName", "datei2.pdf" },
                    {"PermanentUrl", "https://url-to-Salesware.cloud/PermanentUrl" },
                    {"TemporaryUrl", "https://url-to-Salesware.cloud/TemporaryUrl" }
                },
            }           
        }
    };
}

Diese Entitäten enthalten die oben genannten Parameter:

  • Bestellung
  • Bestellposition
  • Angebot
  • Angebotsposition
  • Warenkorb
  • Warenkorbposition

In Salesware werden folgende Klassennamen für die Übergabe der Custom-Felder genutzt:

EntitätKlassennameDatenbank-Tabelle
Adresse / InteressentAdresseKHKAdressen
AngebotVKBelegKHKVKBelege
AngebotspositionVKBelegPositionKHKVKBelegePositionen
AnsprechpartnerAdresseKHKAdressen
AnsprechpartnerAnsprechpartnerKHKAnsprechpartner
ArtikelArtikelKHKArtikel
BestellungVKBelegKHKVKBelege
BestellpositionVKBelegPositionKHKVKBelegePositionen
KundeAdresseKHKAdressen
KundeKontokorrentKHKKontokorrent
LieferantAdresseKHKAdressen
LieferantKontokorrentKHKKontokorrent
WarenkorbVKBelegKHKVKBelege
WarenkorbpositionenVKBelegPositionKHKVKBelegePositionen

War dieser Beitrag hilfreich?

0
0 Kommentare

Es gibt noch keine Kommentare

Hinterlassen Sie einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert