Eingabeparameter
Allgemeine Eingabeparameter
Alle Parameter für die Aktion werden im Methoden-Parameter übergeben. Folgende Parameter stehen immer zur Verfügung:
Key | Datentyp | Value |
---|---|---|
Client | Sagede.OfficeLine.Engine.Mandant | das Mandanten-Objekt |
CultureId | string | die ID der beim Salesware-Benutzer hinterlegten Lokalisierung / Oberflächensprache |
LocationKey | string | der technische Schlüssel des Standortes, den der Salesware-Benutzer aktuell verwendet |
ManuallyTriggeredEntity | Dictionary<string, object> | der EntityIdentifier für die auslösende Sub-Entität |
TriggeredBy | string | der Trigger, welcher die Aktion ausgelöst hat |
User | Dictionary<string, object> | die Benutzerdaten des angemeldeten Benutzers (crm) oder Business-Logins (reseller) |
SaleswareClientId | string | die Client-Id des Salesware-Clients |
Der EntityIdentifier wiederum beinhaltet folgende Elemente:
Key | Datentyp | Value |
---|---|---|
EntityType | string | der Typ der auslösenden Sub-Entität, z. B. Position |
EntityKey | string | der Salesware-Key für diesen Datensatz |
Diese Daten werden für den angemeldeten Benutzer oder Business-Login übergeben:
Key | Datentyp | Value | Hinweis |
---|---|---|---|
Name | string | der Name | |
FirstName | string | der Vorname | |
UserAccountType | string | der Kontotyp (crm | reseller) | |
string | die E-Mailadresse | ||
CustomerNumber | string | die Kundennummer des zugehörigen Kunden | nur bei Business-Logins (reseller) |
UserGroups | string[] | ein Array der technischen Schlüssel der zugeordneten Benutzergruppen (bei Benutzern) oder der zugeordneten Business-Login-Gruppen (bei Business-Logins) | |
ErpRepresentative | string | der technische Schlüssel des hinterlegten ERP Vertreters | nur bei Benutzern (crm) |
ErpUser | string | der Name des hinterlegten ERP-Benutzers | nur bei Benutzern (crm) |
In einigen Aktionen stehen auch Positionsdaten zur Verfügung. Das sind immer folgende Daten:
Key | Datentyp | Value |
---|---|---|
EntityKey | string | der Salesware-Key für diesen Datensatz |
ItemNumber | string | die Artikelnummer |
VariationId | int | die interne Variantennummer (AuspraegungID) |
Quantity | decimal | die Menge |
QuantityType | short | die Mengenart |
QuantityUnit | string | die Mengeneinheit |
UnitPrice | decimal | der Einzelpreis |
DiscountValue | decimal | der Rabattsatz (in Prozent) |
IsManualPrice | bool | das Kennzeichen, ob der Einzelpreis manuell verändert worden ist (EinzelpreisManuell) |
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:
Key | Datentyp | Value |
---|---|---|
ExternalEntityReference | string | Die 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 |
Custom | Dictionary<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) |
Files | Dictionary<string,object>[] | das Array von Datei-Definitionen mit der Möglichkeit zum Downloaden via URL |
Das können die Inhalte der Files sein:
Key | Datentyp | Value |
---|---|---|
FileName | string | der Dateiname zur Anzeige und zur Ermittlung des Dateityps |
PermanentUrl | string | URL 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. |
TemporaryUrl | string | URL 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ät | Klassenname | Datenbank-Tabelle |
---|---|---|
Adresse / Interessent | Adresse | KHKAdressen |
Angebot | VKBeleg | KHKVKBelege |
Angebotsposition | VKBelegPosition | KHKVKBelegePositionen |
Ansprechpartner | Adresse | KHKAdressen |
Ansprechpartner | Ansprechpartner | KHKAnsprechpartner |
Artikel | Artikel | KHKArtikel |
Bestellung | VKBeleg | KHKVKBelege |
Bestellposition | VKBelegPosition | KHKVKBelegePositionen |
Kunde | Adresse | KHKAdressen |
Kunde | Kontokorrent | KHKKontokorrent |
Lieferant | Adresse | KHKAdressen |
Lieferant | Kontokorrent | KHKKontokorrent |
Warenkorb | VKBeleg | KHKVKBelege |
Warenkorbpositionen | VKBelegPosition | KHKVKBelegePositionen |
0 Kommentare