Wiki-Quellcode von Salesforce-Plugin

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