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||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 | |||
55 | |||
56 | Über das Mülltonnen-Symbol | ||
57 | |||
58 | ; Zählername | ||
59 | : Auswahl des Zählers, dessen Wert geändert werden soll. Der Zähler muss vorher in der Zählerkonfiguration angelegt werden. Für jeden Zähler wird sowohl sein Name als auch seine {{smallcaps}}Uuid{{/smallcaps}} angezeigt. Die {{smallcaps}}Uuid{{/smallcaps}} dient der eindeutigen Identifikation des Zählers und wird etwa bei der Abfrage per {{smallcaps}}Ajax{{/smallcaps}} verwendet. | ||
60 | |||
61 | ; Zählaktion | ||
62 | : Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: | ||
63 | :; Hochzählen | ||
64 | :: Erhöht den Wert des Zählers um die eingegebene Zahl. | ||
65 | :; Herunterzählen | ||
66 | :: Erniedrigt den Wert des Zählers um die eingegebene Zahl. | ||
67 | :; Zähler auf Startwert zurücksetzen | ||
68 | :: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. | ||
69 | ; Schrittweite | ||
70 | : Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll. Nicht verfügbar, wenn //Zähler auf Startwert zurücksetzen// ausgewählt wurde. | ||
71 | |||
72 | ==== Allgemeine Rückgabeparameter ==== | ||
73 | |||
74 | |||
75 | |||
76 | === Rückgabeparameter der Aktion === | ||
77 | |||
78 | Manchmal ist es notwendig, auf das Ergebnis der Zählaktion zugreifen zu können, wie zum Beispiel den aktuellen Wert oder den Statuscode. Dies kann über [[Aktionsplatzhalter>>doc:Formcycle.UserInterface.Variables]] geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabeparametern kann eingestellt werden, über welchem Schlüssel auf die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].Counter%]// auf den aktuellen Zählwert zugegriffen werden. Folgende Rückgabeparameter sind verfügbar: | ||
79 | |||
80 | |||
81 | Der ResultCode Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglichkann dabei folgende Werte aufweisen: | ||
82 | |||
83 | |||
84 | |||
85 | |||
86 | |||
87 | |||
88 | |||
89 | |||
90 | {{figure image="plugin_result.png"}} | ||
91 | Konfiguration der Rückgabewerte | ||
92 | {{/figure}} | ||
93 | |||
94 | In diesem Bereich werden die vom Plugin als Ergebnis des DMS Datei-Upload Prozesses 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: | ||
95 | |||
96 | {{code}} | ||
97 | |||
98 | [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] | ||
99 | {{/code}} | ||
100 | |||
101 | ; ResultCode | ||
102 | : Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. | ||
103 | ; ResultMessage | ||
104 | : Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. | ||
105 | ; ResultDocumentID | ||
106 | : 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. | ||
107 | |||
108 | {{info}} | ||
109 | Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert | ||
110 | und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden. | ||
111 | {{/info}} | ||
112 | |||
113 | Der ResultCode enthält nummerischer Zahlenwerte, welche dazu verwendet werden können, den Erfolg der Aktion zu bestimmen. Folgende Ergebnisnummern sind möglich: | ||
114 | |||
115 | {{table dataTypeNum="0" preSort="0-asc"}} | ||
116 | |=Rückgabewert|=Bedeutung | ||
117 | |0|Das Plugin wurde fehlerfrei ausgeführt. | ||
118 | |10|Die Salesforce-Authentifizierung ist fehlgeschlagen, überprüfen Sie bitte ihre Nutzer-Credentials. | ||
119 | |30|Es konnte keine Verbindung zum Salesforce-Service aufgebaut werden. | ||
120 | |31|Aufruf einer Webservice-Methode lieferte Fehler | ||
121 | |40|In {{formcycle/}} ist ein nicht näher spezifizierter Fehler aufgetreten. | ||
122 | {{/table}} | ||
123 | |||
124 | |||
125 | |||
126 | |||
127 | ##clear="h1" | ||
128 |