Wiki-Quellcode von Salesforce-Plugin
Zeige letzte Bearbeiter
| 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||rel="noopener noreferrer" 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.jpg" 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 | ; load.catalogue {{version major="3" minor="0" patch="1"/}} | ||
| 30 | : Optionale Limitierung der zu ladenden Kataloge (Komma-separierte Liste) | ||
| 31 | |||
| 32 | |||
| 33 | ; proxy.host {{version major="3" minor="1" patch="0"/}}/{{version major="2" minor="1" patch="0"/}} | ||
| 34 | : Host des zu verwendenden Proxy-Server | ||
| 35 | ; proxy.port {{version major="3" minor="1" patch="0"/}}/{{version major="2" minor="1" patch="0"/}} | ||
| 36 | : Port des zu verwendenden Proxy-Server | ||
| 37 | ; proxy.login.name {{version major="3" minor="1" patch="0"/}}/{{version major="2" minor="1" patch="0"/}} | ||
| 38 | : Benutzername für den optionalen Login am Proxy-Server | ||
| 39 | ; proxy.login.password {{version major="3" minor="1" patch="0"/}}/{{version major="2" minor="1" patch="0"/}} | ||
| 40 | : Passwort für den optionalen Login am Proxy-Server | ||
| 41 | |||
| 42 | Ist am Plugin kein Proxy-Server konfiguriert wird versucht anhand der URL des Serviceendpunkts ein System-Proxy zu ermitteln. | ||
| 43 | |||
| 44 | == Aktions-Plugin: //Salesforce: Create Object// == | ||
| 45 | |||
| 46 | {{figure image="2_Aktion_Oberfläche.png" width="600" clear="h2"}} | ||
| 47 | 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. | ||
| 48 | {{/figure}} | ||
| 49 | |||
| 50 | Nach Installation des Salesforce-Plugins gibt es im [[Workflow>>doc:Formcycle.Designer.Workflow.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: | ||
| 51 | |||
| 52 | === Salesforce Einstellungen === | ||
| 53 | |||
| 54 | ; Salesforce Objekt | ||
| 55 | : Über eine Dropdown-Auswahl muss in diesem Feld der Typ des zu erstellenden Salesforce-Objekts ausgewählt werden. | ||
| 56 | |||
| 57 | === Objekt-Felder === | ||
| 58 | |||
| 59 | 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: | ||
| 60 | |||
| 61 | ; {{ficon name="play-circle-outline1"/}} Schaltfläche | ||
| 62 | : Durch anklicken dieser Schaltfläche können Detailinformationen für das jeweilige Salesforce-Feld geöffnet und wieder geschlossen werden. | ||
| 63 | ; Technischer Name | ||
| 64 | : Der technische Name des Salesforce-Feldes, wie er im Salesforce-Objekt definiert ist. | ||
| 65 | ; Wert | ||
| 66 | : 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. | ||
| 67 | ; {{ficon name="trash-alt"/}} Schaltfläche | ||
| 68 | : Löscht die Zeile, wodurch kein Wert für das entsprechende Salesforce-Feld übertragen wird. | ||
| 69 | |||
| 70 | In der Fußzeile der Tabelle befinden sich die beiden folgenden Schaltflächen: | ||
| 71 | |||
| 72 | ; [[image:icon_update.png]] Schaltfläche | ||
| 73 | : Aktualisiert die Zuordnung zu Formularfeldern. | ||
| 74 | ; {{ficon name="trash-alt2"/}} Schaltfläche | ||
| 75 | : Löscht alle Salesforce-Felder/Zeilen, denen kein Wert zugeordnet wurde. | ||
| 76 | |||
| 77 | === Allgemeine Rückgabeparameter === | ||
| 78 | |||
| 79 | {{figure image="3_Aktion_Rückgabe.png" width="600" clear="h4"}} | ||
| 80 | Konfiguration der Rückgabewerte | ||
| 81 | {{/figure}} | ||
| 82 | |||
| 83 | 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: | ||
| 84 | |||
| 85 | {{code language="none"}} | ||
| 86 | [%$<Aktions-Name>.<Name oder vergebener Alias der Rückgabeparameters>%] | ||
| 87 | {{/code}} | ||
| 88 | |||
| 89 | ; ResultCode | ||
| 90 | : Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. | ||
| 91 | ; ResultMessage | ||
| 92 | : Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. | ||
| 93 | ; SForceObjectID | ||
| 94 | : Enthält die vom Salesforce-Service zurückgelieferte Objekt-ID. | ||
| 95 | |||
| 96 | Über die [[image:icon_placeholder.png]] Schaltfläche neben jedem Eingabefeld kann die Platzhalterauswahl geöffnet werden. | ||
| 97 | |||
| 98 | ==== Mögliche Werte für den ResultCode ==== | ||
| 99 | |||
| 100 | 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: | ||
| 101 | |||
| 102 | {{table dataTypeNum="0" preSort="0-asc"}} | ||
| 103 | |=Status / Fehlercode|=Bedeutung | ||
| 104 | |0|Das Plugin wurde fehlerfrei ausgeführt. | ||
| 105 | |10|Die Salesforce-Authentifizierung ist fehlgeschlagen, überprüfen Sie bitte ihre Nutzer-Credentials. | ||
| 106 | |30|Es konnte keine Verbindung zum Salesforce-Service aufgebaut werden. | ||
| 107 | |31|Aufruf einer Webservice-Methode lieferte Fehler | ||
| 108 | |40|In {{formcycle/}} ist ein nicht näher spezifizierter Fehler aufgetreten. | ||
| 109 | {{/table}} | ||
| 110 | |||
| 111 | {{velocity}} | ||
| 112 | ##clear="h1" | ||
| 113 | {{/velocity}} |