Salesforce-Plugin
Plugin-Download (erfordert Anmeldung)
Über das kostenpflichtige Salesforce-Plugin ist es möglich, Daten aus Xima® Formcycle an ein Salesforce-Objekt zu übermitteln. Das Plugin nutzt dafür die vom Salesforce-System bereitgestellte SOAP-Webservice Schnittstelle.
Installation
Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie hier.
Konfiguration des Plugins
Nach der Installation des Plugins stehen die in der Abbildung dargestellten Konfigurationsparameter zur Verfügung. Folgende Einstellungsmöglichkeiten gibt es dabei:
- auth.endpoint.url
- URL, unter der der Authentifizierungsendpunkt erreicht werden kann.
- service.endpoint.url
- URL, unter der der Serviceendpunkt erreicht werden kann.
- salesforce.login
- Benutzername für die Authentifizierung (Optionaler Parameter)
- salesforce.pwd
- Passwort für die Authentifizierung (Optionaler Parameter)
- salesforce.token
- Zugriffstoken für die Authentifizierung (Optionaler Parameter)
Aktions-Plugin: Salesforce: Create Object
Nach Installation des Salesforce-Plugins gibt es in der Status- und Aktionsverarbeitung 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:
Details für die Plugin-Verarbeitung
Salesforce Einstellungen
- Salesforce Objekt
- Über eine Dropdown-Auswahl muss in diesem Feld der Typ des zu erstellenden Salesforce-Objekts ausgewählt werden.
Nachdem ein Objekt ausgewählt wurde
- Zählername
- 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 Uuid angezeigt. Die Uuid dient der eindeutigen Identifikation des Zählers und wird etwa bei der Abfrage per Ajax verwendet.
- Zählaktion
- Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:
- Hochzählen
- Erhöht den Wert des Zählers um die eingegebene Zahl.
- Herunterzählen
- Erniedrigt den Wert des Zählers um die eingegebene Zahl.
- Zähler auf Startwert zurücksetzen
- Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.
- Schrittweite
- 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.
Allgemeine Rückgabeparameter
Rückgabeparameter der Aktion
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 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:
Der ResultCode Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglichkann dabei folgende Werte aufweisen:
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:
[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
- ResultCode
- Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt.
- ResultMessage
- Enthält eine Klartextmeldung, welche den zurückgelieferten ResultCode näher erläutert.
- ResultDocumentID
- 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.
Über den 
Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden.
Der ResultCode enthält nummerischer Zahlenwerte, welche dazu verwendet werden können, den Erfolg der Aktion zu bestimmen. Folgende Ergebnisnummern sind möglich:
| Rückgabewert | Bedeutung |
|---|---|
| 0 | Das Plugin wurde fehlerfrei ausgeführt. |
| 10 | Die Salesforce-Authentifizierung ist fehlgeschlagen, überprüfen Sie bitte ihre Nutzer-Credentials. |
| 30 | Es konnte keine Verbindung zum Salesforce-Service aufgebaut werden. |
| 31 | Aufruf einer Webservice-Methode lieferte Fehler |
| 40 | In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten. |
- Die Zählaktion wurde erfolgreich abgearbeitet.
- 10 (UNKNOWN_ACTION_ERROR)
- Die Zählaktion kann nicht ausgeführt werden, da eine unbekannte Zählaktion ausgewählt wurde. Aktuell werden die Zählaktionen Hochzählen, Herunterzählen und Auf den Startwert zurücksetzen unterstützt.
- 11 (PARSING_ERROR)
- Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde.
- 40 (INTERNAL_ERROR)
- Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
- ResultMessage
- Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
- Counter
- Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde.
- IsReset
- Entweder true, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder false, wenn er nicht zurückgesetzt wurde.
- CounterAfterReset
- Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen.
Konfiguration der Mail-Server
