For the best experience turn off the battery saving mode.

Back

BSG-Anschluss für Creatio (ehemals BPM.Online)

Installation

Die Installation kann entweder über den Creatio (BPM) Marketplace oder über eine Archivdatei erfolgen, da die Installation vom Marketplace mit einem Klick abgeschlossen werden kann – dies wird in diesem Handbuch nicht behandelt.

Manuelle Installation

Das Archiv mit BSG-Connector kann von der Online-Installation von Creatio (BPM) heruntergeladen werden

Um BSG Connector aus dem Archiv zu installieren, gehen Sie zum Abschnitt „Installierte Anwendung“ im „Systemdesigner“ und wählen Sie „Aus Datei installieren“ aus einer Dropdown-Liste:

Wählen Sie im nächsten Bildschirm die Archivdatei aus und laden Sie sie hoch:

Der Installationsvorgang startet automatisch, wenn Fehler auftreten. Bitte führen Sie das Installationsprotokoll und leiten Sie es an unseren Support weiter:support@bsg.world

Aufbau

Sie müssen BSG Connector vor der Verwendung konfigurieren: Geben Sie den API-Schlüssel und den Standard-Absendernamen an.

Um zur Konfigurationsseite für BSG Connector zu gelangen, gehen Sie bitte zu „System Designer“.:

Klicken Sie dann im Abschnitt „Importieren und Integration“ auf den Link „BSG Connector-Einstellungen“:

Der modale Dialog mit den BSG Connector-Einstellungen:

Wenn Sie keinen API-Schlüssel für den BSG-Dienst haben, klicken Sie auf den Link „BSG-Schlüssel abrufen“ und authentifizieren Sie sich im BSG-Bereich:

Klicken Sie auf die Schaltfläche „Generieren“ und kopieren Sie den empfangenen API-Schlüssel:

live_1omLRXzXXXXXXXXXX – für die Produktion

oder

test_1omLRXzXXXXXXXXXX – zum Testen

Geben Sie den empfangenen Schlüssel in das Eingabefeld „API-Schlüssel“ ein:

und klicken Sie auf „Speichern“.

Bei Erfolg wird das Bestätigungsfenster angezeigt:

There is also the direct link to connector’s configuration page right from main form, but only if current user is administrator:

Wenn der Connector zuvor konfiguriert wurde, wird stattdessen ein Link zum Trennen des BSG-Dienstes angezeigt:

Verwendungszweck

Unser BSG Connector wurde für allgemeine Anwendungsfälle entwickelt und verfügt über wichtige Funktionen:

  • single SMS delivery,
  • mass delivery,
  • message templates,
  • template tags
  • balance check
  • count SMS messages

Wenn Ihr Unternehmen spezifischere Funktionen benötigt oder erweiterte Anpassungen erforderlich sind, wenden Sie sich an unser Support-Team support@bsg.world

Einzelne SMS Zustellung

Das Hauptformular für den SMS-Versand befindet sich auf der Registerkarte „BSG“ im oberen Bereich der ausgewählten Kontaktseite:

Hauptformular im Detail:

Steuerelemente:

  • Selected contact and the phone that SMS message will be send to
  • Dropdown with allowed tags
  • Message text
  • Validation messages
  • Symbol counter with split for actual SMS messages
  • Select pre-defined message template
  • Check balance in BSG Service (if connected)
  • Link/Unlink BSG Account from connector
  • Send SMS action button
  • Encode message into translit

Bei erfolgreicher lieferung wird ein benachrichtigungsfenster angezeigt:

Massen SMS Zustellung

Unser BSG-Anschluss ermöglicht die Massenzustellung von SMS-Nachrichten an mehrere ausgewählte Kontakte (oder an alle). Dazu müssen Sie zum Abschnitt „Kontakte“ gehen und im Menü „Aktionen“ die Option „Mehrere Datensätze auswählen“ oder „Alle auswählen“ auswählen.:

Nachdem Sie die erforderlichen Kontakte ausgewählt haben, müssen Sie die Option „SMS senden (BSG)“ auswählen:

Es wird einen modalen Dialog mit Details für die Massen-SMS-Zustellung geben:

Steuerelemente:

  • Number of selected contacts
  • SMS message text, supports tags input
  • Selection of pre-defined message template
  • Symbol counter with split for actual SMS messages
  • Action button to start mass delivery
  • Encode message to latin
  • Select tags for SMS message substitutions (see below)

Kontostand prüfen

Diese option ist erst nach erfolgreicher Verknüpfung mit dem BSG-Konto verfügbar. Um Ihr Guthaben in BSG anzuzeigen, klicken Sie im Hauptverbindungsformular auf den Link „Guthaben“:

Es wird ein modales fenster mit balance details geben:

SMS nachrichtenvorlagen

Unser connector ermöglicht das erstellen, verwenden und verwalten von SMS Nachrichtenvorlagen. Um diese funktion zu nutzen, klicken sie im hauptverbindungsformular (oder im massenlieferungsformular) auf den link „Vorlage“:

Hauptbildschirm für SMS nachrichtenvorlagen:

Steuerelemente:

  • Select current template from list and back to delivery form
  • Add new template
  • Template search

Bei der vorlagenauswahl sind allgemeine wörterbuchaktionen zulässig:

Und standardsteuerung der aktuellen ansicht:

Filteroptionen für die vorlagensuche:

Um die neue vorlage zu erstellen, klicken sie auf die schaltfläche „Neu“. Es wird ein modales fenster angezeigt:

Steuerelemente:

  • Action button to Save template
  • Template name
  • SMS message text

Die SMS nachricht ermöglicht auch die eingabe von tags.

Vorlagen Tags

Unser Connector unterstützt Tags in SMS-Nachrichten. Um sie zu verwenden, müssen Sie ein spezielles Schlüsselwort in den Nachrichtentext einfügen. Es wird automatisch durch die tatsächlichen Kontaktdaten ersetzt.

Unten finden Sie eine Liste der unterstützten Tags:

Tag Description
#name# Full name of a contact
#GivenName# First name
#MiddleName# Middle name
#Surname# Surname
#JobTitle# Job Title
#BirthDate# Date of birth
#MobilePhone# Mobile phone
#Phone# Work phone
#HomePhone# Home phone
#Skype# Skype
#Email# Email
#Address# Address
#Zip# Zip

 

Bei allen Tags wird die Groß- und Kleinschreibung nicht berücksichtigt, sodass alle funktionieren: # name #, # NAME #, # Name #

Absendername überschreiben

Unser Connector ermöglicht das Überschreiben des Standard-Absendernamens für einen Wert, der im zugehörigen Konto angegeben ist.

Wenn dieses Feld ausgefüllt ist, gibt es ein bestimmtes Feld „Absendername (BSG)“, das unser Connector bei der Installation zur Kontoentität hinzufügt. Der Wert wird für alle Kontakte verwendet, die dieser Kontoentität zugeordnet sind.

Um diese Funktion zu verwenden, gehen Sie zur Kontoseite:

Füllen Sie das Feld „Absendername (BSG)“ aus und klicken Sie auf „Speichern“.

Verwendung im Creatio-Prozess (ehemals BPM)

Unser Connector ermöglicht die Verwendung der BSG-Servicebereitstellung als Schritt im Creatio-Prozess. Im Folgenden finden Sie eine schrittweise Anleitung zum Hinzufügen eines solchen Schritts zum neuen Creatio-Prozess.

Gehen Sie zu „Prozessbibliothek“:

Drücken sie ‘New process’ taste:

From the list on left (titled ‘User actions’) select ‘Send SMS’ option and drag it to BPM diagram:

Die Linie vom Beginn des Prozesses sollte mit unserem Schritt verbunden sein, genauso wie die Linie von unserem Schritt bis zum Ende des Prozesses.

Jetzt müssen Sie die Schrittparameter von (rechts) aus eingeben:

Diese Parameter werden normalerweise aus vorherigen Schritten des Creatio-Prozesses ausgefüllt, sodass der Bereitstellungsschritt sie aus der Umgebung des aktuellen Prozesses übernimmt.

Um zu überprüfen, ob der Prozess korrekt erstellt wurde, klicken Sie auf die Schaltfläche „Ausführen“:

Verwenden des Connectors aus Creatio BPM-Skripten

Unser Connector ermöglicht die Verwendung über die sogenannte „Skriptaufgabe“ – den speziellen Schritt im Creatio-Prozessablauf mit benutzerdefiniertem Skript.

Im Folgenden finden Sie eine schrittweise Anleitung, wie Sie diese für die Massen-SMS-Zustellung verwenden können.

  1. Navigieren Sie zum Abschnitt „Prozessbibliothek“ und erstellen Sie einen neuen BPM-Prozess. Fügen Sie die Schritte „Daten lesen“ und „Skriptaufgabe“ hinzu (siehe Abbildung unten):
  2. Klicken Sie auf den Schritt „Daten lesen“ und konfigurieren Sie die Parameter wie auf dem Bildschirm unten dargestellt:

    Connector erwartet die Erfassung von IDs nur von der Entität „Kontakt“, sodass alle anderen abgerufenen Felder nicht verwendet werden.
    Klicken Sie auf den Schritt „Skriptaufgabe“ und fügen Sie den folgenden Code ein
    :

    var log = global::Common.Logging.LogManager.GetLogger("BSGConnector");
    var userConnection = this.Get<UserConnection>("UserConnection");
    log.Info("test process has been started " );
    try {
    var colSource = Get<ICompositeObjectList<ICompositeObject>>("ReadDataUserTask1.ResultCompositeObjectList");
    var listIds = new List<Guid>();
    foreach (var parameter in colSource)
    {
    Guid value;
    parameter.TryGetValue("Id",out value);
    listIds.Add(value);
    log.Info(string.Format("parameter {0}",value));
    }
    log.Info(string.Format("total number of records: {0}",listIds.Count));
    var p = new Terrasoft.Configuration.BSGConnector.BSGUserTaskParameters();
    p.ContactIds = listIds;
    p.SmsMessage = "test message for mass delivery check, for #name# !";
    p.SenderName = "Santa-Claus";
    var smsTask = new Terrasoft.Configuration.BSGConnector.BSGUserTask(userConnection);
    smsTask.SendSms(p);
    } catch(Exception e) {
    log.Info("process error: " +e.Message);
    }
    return true;

Sollte wie folgt aussehen:

Bei diesem Testvorgang werden Protokolldatensätze in die Standardprotokolldatei (Common.log) geschrieben. Diese Datensätze können auch zur Laufzeit mit der Erweiterung „Telemetrie“ angezeigt werden (siehe unten):

Fehlerbehebung

Unser Connector unterstützt mehrere Protokollierungsebenen. Um die Ursache des Problems zu untersuchen, können Sie die Protokollstufe des Connectors anpassen, um weitere Details zu seiner internen Arbeit anzuzeigen.

Loggername: BSGConnector

Eine ausführliche Anleitung zum Einrichten der Protokollierung in der Offsite-Instanz von Creatio Online finden Sie in der Dokumentation zu Creatio (ehemals BPM Online).

Für Cloud-Instanzen können Sie diese Erweiterung «Telemetrieprotokoll für Creatio» ausprobieren:

https://marketplace.creatio.com/app/telemetry-log-creatio

Dadurch können Connector-Protokolle in Echtzeit überwacht werden:

Bei Fragen zum Stecker wenden Sie sich bitte an unseren technischen Support: support@bsg.world