Wiki source code of Salesforce-Plugin
Hide last authors
author | version | line-number | content |
---|---|---|---|
![]() |
1.10 | 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) |
![]() |
1.4 | 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 | |||
![]() |
1.6 | 13 | {{figure image="1_Plugin_Konfiguration.png"}} |
14 | Die Konfigurationsoberfläche des Plugins. Hier werden Einstellungen zur Verbindung mit dem Salesforce-Server getroffen. | ||
![]() |
1.4 | 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 | |||
![]() |
1.6 | 19 | ; auth.endpoint.url |
![]() |
1.7 | 20 | : {{smallcaps}}URL{{/smallcaps}}, unter der der Authentifizierungsendpunkt erreicht werden kann. |
![]() |
1.6 | 21 | ; service.endpoint.url |
![]() |
1.7 | 22 | : {{smallcaps}}URL{{/smallcaps}}, unter der der Serviceendpunkt erreicht werden kann. |
![]() |
1.6 | 23 | ; salesforce.login |
![]() |
1.8 | 24 | : Benutzername für die Authentifizierung (Optionaler Parameter) |
![]() |
1.6 | 25 | ; salesforce.pwd |
![]() |
1.8 | 26 | : Passwort für die Authentifizierung (Optionaler Parameter) |
![]() |
1.6 | 27 | ; salesforce.token |
![]() |
1.9 | 28 | : Zugriffstoken für die Authentifizierung (Optionaler Parameter) |
![]() |
1.6 | 29 | |
![]() |
1.11 | 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//. Hier kann festgelegt werden, welcher Zähler in welcher Weise geändert werden soll (hochzählen, herunterzählen etc). | ||
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 Salesforce Objekt 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 | |||
![]() |
1.12 | 45 | Nachdem ein Objekt ausgewählt wurde |
![]() |
1.11 | 46 | |
47 | ; Zählername | ||
48 | : 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. | ||
49 | |||
50 | ; Zählaktion | ||
51 | : Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: | ||
52 | :; Hochzählen | ||
53 | :: Erhöht den Wert des Zählers um die eingegebene Zahl. | ||
54 | :; Herunterzählen | ||
55 | :: Erniedrigt den Wert des Zählers um die eingegebene Zahl. | ||
56 | :; Zähler auf Startwert zurücksetzen | ||
57 | :: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. | ||
58 | ; Schrittweite | ||
59 | : 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. | ||
60 | |||
![]() |
1.12 | 61 | ==== Allgemeine Rückgabeparameter ==== |
62 | |||
63 | |||
64 | |||
![]() |
1.11 | 65 | === Rückgabeparameter der Aktion === |
66 | |||
67 | 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: | ||
68 | |||
![]() |
1.12 | 69 | |
70 | Der ResultCode Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglichkann dabei folgende Werte aufweisen: | ||
71 | |||
72 | |||
73 | |||
74 | |||
75 | |||
76 | |||
77 | |||
78 | |||
79 | {{figure image="plugin_result.png"}} | ||
80 | Konfiguration der Rückgabewerte | ||
81 | {{/figure}} | ||
82 | |||
83 | 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: | ||
84 | |||
85 | {{code}} | ||
86 | |||
87 | [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] | ||
88 | {{/code}} | ||
89 | |||
![]() |
1.11 | 90 | ; ResultCode |
![]() |
1.12 | 91 | : Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. |
92 | ; ResultMessage | ||
93 | : Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. | ||
94 | ; ResultDocumentID | ||
95 | : 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. | ||
96 | |||
97 | {{info}} | ||
98 | Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert | ||
99 | und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden. | ||
100 | {{/info}} | ||
101 | |||
102 | Der ResultCode enthält nummerischer Zahlenwerte, welche dazu verwendet werden können, den Erfolg der Aktion zu bestimmen. Folgende Ergebnisnummern sind möglich: | ||
103 | |||
![]() |
1.16 | 104 | {{table dataTypeNum="0" preSort="0-asc"}} |
![]() |
1.14 | 105 | |=Rückgabewert|=Bedeutung |
![]() |
1.15 | 106 | |0|Das Plugin wurde fehlerfrei ausgeführt. |
107 | |10|Die Salesforce-Authentifizierung ist fehlgeschlagen, überprüfen Sie bitte ihre Nutzer-Credentials. | ||
108 | |30|Es konnte keine Verbindung zum Salesforce-Service aufgebaut werden. | ||
109 | |31|Aufruf einer Webservice-Methode lieferte Fehler | ||
![]() |
1.17 | 110 | |40|In {{formcycle/}} ist ein nicht näher spezifizierter Fehler aufgetreten. |
![]() |
1.14 | 111 | {{/table}} |
![]() |
1.11 | 112 | |
113 | |||
114 | |||
115 | |||
![]() |
1.17 | 116 | ##clear="h1" |
![]() |
1.11 | 117 |