Externe Steuerung via URL-Parameter
Sie können Salesware per URL aufrufen und dabei Parameter nutzen, um die Anwendung von außen zu steuern, beispielsweise um direkt eine Suche auszulösen oder Datensätze anzulegen.
Grundlagen
Bei der Steuerung über URL-Parameter handelt es sich um Schlüsselworte, denen Werte zugewiesen werden.
- Der Aufruf muss ohne den versionierten Teil der URL erfolgen (z. B.
https://salesware.cloud/login?). - Der erste Parameter wird mit einem
?an die URL angehängt. - Jeder weitere Parameter wird mit einem
&verknüpft. - Die Wertzuweisung erfolgt über ein
=.
Syntax:
[SaleswareUrl]?[Parameter 1]=[Wert 1]&[Parameter 2]=[Wert 2]
Login-Steuerung
Sie können den Login-Prozess unterstützen, indem Sie die Firmenkennung und den Benutzernamen bereits in der URL übergeben. Es ist jedoch nicht möglich, den gesamten Anmeldeprozess automatisiert zu durchlaufen.
| Parameter | Beschreibung |
|---|---|
client |
Die für die Anmeldung erforderliche Firmenkennung. |
login |
Der für die Anmeldung erforderliche Benutzername. |
Login-Szenarien
Salesware verhält sich je nach Anmelde-Status des Benutzers unterschiedlich:
- Szenario 1: Benutzer bereits eingeloggt (Daten identisch) Stimmen Firmenkennung und Benutzername der URL mit dem aktiven Benutzer überein, wird der Link direkt aufgerufen.
- Szenario 2: Benutzer bereits eingeloggt (Daten abweichend) Weichen die Daten ab, muss sich der Benutzer neu anmelden. Die Felder für Firmenkennung und Benutzername sind dabei mit den Werten aus der URL vorausgefüllt.
- Szenario 3: Benutzer bereits eingeloggt (URL ohne Firmenkennung) Der Link wird direkt aufgerufen.
- Szenario 4: Benutzer nicht eingeloggt Der Benutzer muss sich zuerst anmelden. Firmenkennung und Benutzername (falls in der URL vorhanden) sind bereits vorausgefüllt.
Aktionen (rcAction)
Nach der Authentifizierung können verschiedene Remote Control Aktionen (rcActions) ausgelöst werden.
| Parameter | Mögliche Werte | Beschreibung |
|---|---|---|
rcAction |
search |
Führt eine Suche in einer Entität aus. |
link |
Öffnet einen internen Link innerhalb der Anwendung. | |
entitylookup |
Öffnet einen spezifischen Datensatz über dessen Schlüssel. | |
createEntity |
Erstellt einen neuen Datensatz (Entität). |
Aktion: Suche
Um eine Suche (rcAction=search) auszuführen, müssen weitere Parameter zur Spezifizierung angegeben werden.
| Parameter | Mögliche Werte | Beschreibung |
|---|---|---|
rcEntityType |
activity, contact, item, mail, offer, order |
Bestimmt die Ziel-Entität. Hinweis: customer wird intern auf contact gemappt. |
rcSearchTerm |
Freitext | Der Suchbegriff. Mehrere Begriffe werden mit einem + getrennt. Standard ist *. |
rcSingleResultOption |
list, details, sidebar |
Optional: Definiert die Ansicht bei einem eindeutigen Treffer. |
rcTags |
JSON-Array (URL-kodiert) | Ermöglicht das Filtern auf spezifische Felder. |
Aktion: Entity Lookup
Diese Aktion ermöglicht das direkte Öffnen eines Datensatzes, wenn dessen eindeutiger Schlüssel bekannt ist.
| Parameter | Wert | Beschreibung |
|---|---|---|
rcEntityType |
Entitätstyp | Der Typ der Entität (z. B. contact). |
rcEntityKey |
Schlüssel | Der eindeutige Identifikator des Datensatzes. |
Aktion: Datensatz erstellen (createEntity)
Mit dieser Aktion wird ein neuer Datensatz initialisiert. Es erfolgt eine Berechtigungsprüfung auf das Recht zum Einfügen von Daten (canInsert).
| Parameter | Wert | Beschreibung |
|---|---|---|
rcEntityType |
Entitätstyp | Pflicht. Ziel-Entität (z. B. order, contact, activity). |
rcEntitySuperType |
Spezialisierung | Pflicht, falls die Entität Super-Typen besitzt (z. B. customer bei Kontakt oder system.task bei Aktivität). |
Automatische Verknüpfung (Plugins)
Beim Erstellen einer Entität kann diese automatisch mit einem bestehenden Datensatz verknüpft werden. Aktuell steht hierfür das Plugin contactPhone zur Verfügung.
| Parameter | Wert | Beschreibung |
|---|---|---|
rcLinkedEntityPlugin |
contactPhone |
Sucht einen Kontakt anhand einer Telefonnummer. |
rcLinkedEntityContactPhoneSearchValue |
Telefonnummer | Die Nummer für die Suche. |
Verhalten des Plugins:
- Bei einem Treffer wird die neue Entität automatisch verknüpft.
- Bei mehreren Treffern erscheint ein Auswahldialog für den Benutzer.
- Bei keinem Treffer wird die Entität ohne Verknüpfung angelegt.
Hinweis Das Plugin
contactPhonewird nur für die Typenactivity,orderundofferunterstützt.
Praxisbeispiele
Suche via Telefonanlage (Sidebar bei eindeutigem Ergebnis):
https://salesware.cloud/login?rcAction=search&rcEntityType=contact&rcSearchTerm=108764&rcSingleResultOption=sidebar
Neuen Kontakt (Kunde) anlegen:
https://salesware.cloud/login?rcAction=createEntity&rcEntityType=contact&rcEntitySuperType=customer
Neue Bestellung mit Kontakt-Suche per Telefonnummer:
https://salesware.cloud/login?rcAction=createEntity&rcEntityType=order&rcLinkedEntityPlugin=contactPhone&rcLinkedEntityContactPhoneSearchValue=09090%2096475-0