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"}} | ||
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 | ||
28 | : Zugriffstoken für die Authentifizierung (Optionaler Parameter) | ||
29 | |||
30 | == Aktions-Plugin: //Salesforce: Create Object// == | ||
31 | |||
32 | {{figure image="2_Aktion_Oberfläche.png" width="400"}} | ||
33 | Die Einstellungen für die Verarbeitungsaktion //Salesforce: Create Object//. | ||
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 eine neue Instanz eines Salesforce Objekts erstellt werden kann. Neben den Standardeinstellungen der Aktion für Name und Bemerkungen gibt es die folgenden Parameter: | ||
37 | |||
38 | === Details für die Plugin-Verarbeitung === | ||
39 | |||
40 | ==== Salesforce Einstellungen ==== | ||
41 | |||
42 | ; Salesforce Objekt | ||
43 | : Über eine Dropdown-Auswahl muss in diesem Feld der Typ des zu erstellenden Salesforce-Objekts ausgewählt werden. | ||
44 | |||
45 | Nachdem ein Objekt ausgewählt wurde, können in der Tabelle //Objekt-Felder// die Werte festegelegt werden, welche in die neue Objekt-Instanz 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 Objekt-Instanz für das Salesforce-Feldes verwendet werden soll. Hier können auch [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] verwendet werden. Dafür befindet sich ein | ||
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 | ==== Allgemeine Rückgabeparameter ==== | ||
57 | |||
58 | |||
59 | |||
60 | === Rückgabeparameter der Aktion === | ||
61 | |||
62 | {{figure image="plugin_result.png"}} | ||
63 | Konfiguration der Rückgabewerte | ||
64 | {{/figure}} | ||
65 | |||
66 | In diesem Bereich werden die vom Salesforce-Plugin als Ergebnis der Erstellung der neuen Objekt-Instanz 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: | ||
67 | |||
68 | {{code language="none"}} | ||
69 | [%$<Aktions-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] | ||
70 | {{/code}} | ||
71 | |||
72 | ; ResultCode | ||
73 | : Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. | ||
74 | ; ResultMessage | ||
75 | : Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. | ||
76 | ; ResultDocumentID | ||
77 | : Enthält die vom d.3 System zurückgelieferte Dokument-ID, wenn das Dokument erfolgreich im d.3 System abgelegt werden konnte, sonst den Wert -1. | ||
78 | |||
79 | {{info}} | ||
80 | Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert | ||
81 | und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden. | ||
82 | {{/info}} | ||
83 | |||
84 | Der ResultCode enthält nummerischer Zahlenwerte, welche dazu verwendet werden können, den Erfolg der Aktion zu bestimmen. Folgende Ergebnisnummern sind möglich: | ||
85 | |||
86 | {{table dataTypeNum="0" preSort="0-asc"}} | ||
87 | |=Status / Fehlercode|=Bedeutung | ||
88 | |0|Das Plugin wurde fehlerfrei ausgeführt. | ||
89 | |10|Die Salesforce-Authentifizierung ist fehlgeschlagen, überprüfen Sie bitte ihre Nutzer-Credentials. | ||
90 | |30|Es konnte keine Verbindung zum Salesforce-Service aufgebaut werden. | ||
91 | |31|Aufruf einer Webservice-Methode lieferte Fehler | ||
92 | |40|In {{formcycle/}} ist ein nicht näher spezifizierter Fehler aufgetreten. | ||
93 | {{/table}} | ||
94 | |||
95 | |||
96 | |||
97 | |||
98 | ##clear="h1" | ||
99 |