Wiki source code of Salesforce-Plugin
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-bundle-salesforce&fileid=24242||target="_blank"]] (erfordert Anmeldung) | ||
2 | |||
3 | {{content/}} | ||
4 | |||
5 | Über das kostenpflichtige Salesforce-Plugin ist es möglich, Daten aus {{formcycle/}} an ein Salesforce-Objekt zu übermitteln. Das Plugin nutzt dafür die vom Salesforce-System bereitgestellte [[SOAP>>https://de.wikipedia.org/wiki/SOAP||rel="noopener noreferrer" target="_blank" title="Simple Object Access Protocol"]]-Webservice Schnittstelle. | ||
6 | |||
7 | == Installation == | ||
8 | |||
9 | Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]]. | ||
10 | |||
11 | == Konfiguration des Plugins == | ||
12 | |||
13 | {{figure image="1_Plugin_Konfiguration.png" width="600" clear="h2"}} | ||
14 | Die Konfigurationsoberfläche des Plugins. Hier werden Einstellungen zur Verbindung mit dem Salesforce-Server getroffen. | ||
15 | {{/figure}} | ||
16 | |||
17 | Nach der Installation des Plugins stehen die in der Abbildung dargestellten Konfigurationsparameter zur Verfügung. Folgende Einstellungsmöglichkeiten gibt es dabei: | ||
18 | |||
19 | ; auth.endpoint.url | ||
20 | : {{smallcaps}}URL{{/smallcaps}}, unter der der Authentifizierungsendpunkt erreicht werden kann. | ||
21 | ; service.endpoint.url | ||
22 | : {{smallcaps}}URL{{/smallcaps}}, unter der der Serviceendpunkt erreicht werden kann. | ||
23 | ; salesforce.login | ||
24 | : Benutzername für die Authentifizierung (Optionaler Parameter) | ||
25 | ; salesforce.pwd | ||
26 | : Passwort für die Authentifizierung (Optionaler Parameter) | ||
27 | ; salesforce.token {{version major="2" minor="0" patch="1"/}} | ||
28 | : Zugriffstoken für die Authentifizierung (Optionaler Parameter, ab Plugin-Version 2.0.1) | ||
29 | |||
30 | == Aktions-Plugin: //Salesforce: Create Object// == | ||
31 | |||
32 | {{figure image="2_Aktion_Oberfläche.png" width="600" clear="h2"}} | ||
33 | Die Einstellungen für die Verarbeitungsaktion //Salesforce: Create Object//, nachdem ein Objekt gewählt wurde. In der Tabelle //Objekt-Felder// können für die Felder des Objekts //Ordner// Werte festgelegt werden. | ||
34 | {{/figure}} | ||
35 | |||
36 | Nach Installation des Salesforce-Plugins gibt es in der [[Status- und Aktionsverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] eine neue Aktion namens //Salesforce: Create Object//, mit der ein neuer Datensatz für ein Salesforce Objekts erstellt werden kann. Neben den Standardeinstellungen der Aktion für Name und Bemerkungen gibt es im Container //Details für die Plugin-Verarbeitung// die folgenden Parameter: | ||
37 | |||
38 | === Salesforce Einstellungen === | ||
39 | |||
40 | ; Salesforce Objekt | ||
41 | : Über eine Dropdown-Auswahl muss in diesem Feld der Typ des zu erstellenden Salesforce-Objekts ausgewählt werden. | ||
42 | |||
43 | === Objekt-Felder === | ||
44 | |||
45 | Nachdem ein Objekt ausgewählt wurde, können in der Tabelle //Objekt-Felder// die Werte festgelegt werden, welche in den neuen Datensatz geschreiben werden sollen. Jede Tabellenzeile enhält dabei die folgenden Spalten: | ||
46 | |||
47 | ; {{ficon name="play-circle-outline1"/}} Schaltfläche | ||
48 | : Durch anklicken dieser Schaltfläche können Detailinformationen für das jeweilige Salesforce-Feld geöffnet und wieder geschlossen werden. | ||
49 | ; Technischer Name | ||
50 | : Der technische Name des Salesforce-Feldes, wie er im Salesforce-Objekt definiert ist. | ||
51 | ; Wert | ||
52 | : Der Wert, welcher in der zu erstellenden neuen Datensatz für das Salesforce-Feldes verwendet werden soll. Hier können auch [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] verwendet werden. Dafür befindet sich eine [[image:icon_placeholder.png]] Schaltfläche rechts neben dem Eingabefeld. | ||
53 | ; {{ficon name="trash-alt"/}} Schaltfläche | ||
54 | : Löscht die Zeile, wodurch kein Wert für das entsprechende Salesforce-Feld übertragen wird. | ||
55 | |||
56 | In der Fußzeile der Tabelle befinden sich die beiden folgenden Schaltflächen: | ||
57 | |||
58 | ; [[image:icon_update.png]] Schaltfläche | ||
59 | : Aktualisiert die Zuordnung zu Formularfeldern. | ||
60 | ; {{ficon name="trash-alt2"/}} Schaltfläche | ||
61 | : Löscht alle Salesforce-Felder/Zeilen, denen kein Wert zugeordnet wurde. | ||
62 | |||
63 | === Allgemeine Rückgabeparameter === | ||
64 | |||
65 | {{figure image="3_Aktion_Rückgabe.png" width="600" clear="h4"}} | ||
66 | Konfiguration der Rückgabewerte | ||
67 | {{/figure}} | ||
68 | |||
69 | In diesem Bereich werden die vom Salesforce-Plugin als Ergebnis der Erstellung des neuen Datensatzes zurückgelieferten Parameter aufgeführt. Für die einzelnen Parameter kann ein Alias vergeben werden. In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden. Der Platzhalter wird dabei nach dem folgenden Muster gebildet: | ||
70 | |||
71 | {{code language="none"}} | ||
72 | [%$<Aktions-Name>.<Name oder vergebener Alias der Rückgabeparameters>%] | ||
73 | {{/code}} | ||
74 | |||
75 | ; ResultCode | ||
76 | : Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. | ||
77 | ; ResultMessage | ||
78 | : Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. | ||
79 | ; SForceObjectID | ||
80 | : Enthält die vom Salesforce-Service zurückgelieferte Objekt-ID. | ||
81 | |||
82 | Über die [[image:icon_placeholder.png]] Schaltfläche neben jedem Eingabefeld kann die Platzhalterauswahl geöffnet werden. | ||
83 | |||
84 | ==== Mögliche Werte für den ResultCode ==== | ||
85 | |||
86 | Der ResultCode enthält numerischer Zahlenwerte, welche dazu verwendet werden können, den Erfolg der Aktion zu bestimmen. Die nachfolgende Tabelle liefert eine Übersicht über alle vom Plugin zurückgelieferten Status- bzw. Fehlercodes: | ||
87 | |||
88 | {{table dataTypeNum="0" preSort="0-asc"}} | ||
89 | |=Status / Fehlercode|=Bedeutung | ||
90 | |0|Das Plugin wurde fehlerfrei ausgeführt. | ||
91 | |10|Die Salesforce-Authentifizierung ist fehlgeschlagen, überprüfen Sie bitte ihre Nutzer-Credentials. | ||
92 | |30|Es konnte keine Verbindung zum Salesforce-Service aufgebaut werden. | ||
93 | |31|Aufruf einer Webservice-Methode lieferte Fehler | ||
94 | |40|In {{formcycle/}} ist ein nicht näher spezifizierter Fehler aufgetreten. | ||
95 | {{/table}} | ||
96 | |||
97 | {{velocity}} | ||
98 | ##clear="h1" | ||
99 | {{/velocity}} |