Hinzufügen benutzerdefinierter Funktionen zu Rainbow-Anwendungen (custo-manifest)

Mit diesem Artikel können Sie den Rainbow-Anwendungen von Firmenmitgliedern benutzerdefinierte Funktionen hinzufügen, indem Sie eine Reihe von Aktionen aus einer custo-manifest.json Datei konfigurieren. Die benutzerdefinierten Funktionen sind für Unternehmen verfügbar, die mit Cloud PBX oder Alcatel-Lucent Enterprise PBX (OmniPCX Enterprise oder OXO Connect) verbunden sind.

Die verfügbaren Aktionen sind:

• Automatisch ausgelöste Aktionen nach Ereignissen:
  • on-outgoing-pbx-call-actions: um eine Aktion auszuführen, wenn ein ausgehender Anruf erfolgt
  • on-incoming-pbx-call-actions: um eine Aktion auszuführen, wenn ein Anruf eingeht
  • on-answering-incoming-pbx-call-actions: führt eine Aktion aus, wenn ein eingehender Anruf entgegengenommen wird
  • on-releasing-incoming-pbx-call-actions: um eine Aktion auszuführen, wenn ein eingehender Anruf beendet wird

Bei eingehenden Anrufen können die Aktionen ein Skript, eine Anwendung oder eine Webseite mit Informationen über den eingehenden Anruf starten.

• Aktionen, die über eine Schaltfläche ausgelöst werden:
  • on-incoming-pbx-call-button-actions: zum Ausführen einer Aktion durch Klicken auf eine Schaltfläche, die im Popup-Fenster für eingehende Anrufe hinzugefügt wurde
  • on-call-log-list-actions: zum Ausführen einer Aktion durch Anklicken einer Schaltfläche, die in jedem Element des Anrufprotokolls eingefügt wird
  • on-contact-list-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die in jedem Element der Kontakte eingefügt ist
  • on-contact-detail-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die im Detailbereich der Kontakte eingefügt ist
  • on-communication-card-actions: um eine Aktion auszuführen, indem Sie auf ein Menü in der Leiste des Anrufmanagers klicken.
  • on-bubble-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die in das Menü Bubbles eingefügt wurde
  • on-bubble-conference-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die in das Menü für Konferenzanrufe eingefügt wurde

Durch Anklicken von Schaltflächen können Aktionen Popup-Fenster öffnen, in denen Sie Kontakten oder Diensten per E-Mail beitreten können.

• Aktionen mit automatischer Informationsanzeige:
  • on-incoming-pbx-call-display-actions: zum Einfügen von Informationen in das Popup-Fenster für eingehende Anrufe
  • on-contact-card-display-actions: zum Einfügen von Informationen in den Detailbereich des Kontakts

• Aktion mit der Anzeige von Drittanbieteranwendungen:
  • on-main-window-actions: um eine Anwendung eines Drittanbieters in der Rainbow Anwendung anzuzeigen (nur wenn die Optionpopout auf true gesetzt ist: siehe: Zusätzliche Felder)

Durch Klicken auf das entsprechende Symbol im linken Fenster können Sie eine Drittanbieter-Anwendung im rechten Teil der Rainbow-Anwendung anzeigen lassen.

Diese Aktionen werden über die Datei custo-manifest.json konfiguriert, die in den Rainbow Anwendungen für Firmenmitglieder bereitgestellt wird.

Die Datei custo-manifest.json kann für Desktop-Rainbow-Anwendungen ohne Einschränkungen und für Web-Rainbow-Anwendungen mit Einschränkungen bereitgestellt werden: siehe: Hauptfelder.

Die Konfiguration besteht in:

1. Exportieren einer Vorlage der Datei custo-manifest.json aus der Rainbow Verwaltungsanwendung auf den Computer
2. Bearbeiten und Vervollständigen der Datei custo-manifest.json
3. Importieren der Datei custo-manifest.json in die Rainbow Verwaltungsanwendung
4. Bereitstellen der Datei custo-manifest.json in Rainbow-Anwendungen für Firmenmitglieder

Wenn Sie die Datei custo-manifest.json über die Rainbow-Anwendung für Firmenmitglieder bereitstellen, kann sie nicht mehr lokal über die Rainbow-Anwendung für Firmenmitglieder konfiguriert werden: Export-/Importoptionen werden nicht mehr angeboten.

Voraussetzungen

• Sie müssen über ein Administratorkonto in der Firma mit einer Business-, Enterprise- oder Attendant-Lizenz verfügen.

Übersicht über die Datei Custo-manifest

Die custo-manifest Datei besteht aus zwei Teilen:

• Der erste Teil listet alle verfügbaren Aktionen auf und enthält für jede Aktion eine Vorlage mit den wichtigsten Parametern zum Ausfüllen.
  Beispiel:
  
• Der zweite Teil enthält eine Hilfe, die Sie für die Konfiguration lesen können.

Eine Aktion wird durch eine Reihe von Parametern definiert, die in den folgenden Abschnitten beschrieben werden.

Die folgenden Aktionen unterstützen bis zu drei Erweiterungen:

• on-main-window-actions
• on-Kontakt-Detail-Aktionen
• on-Kommunikationskarte-Aktionen
• on-bubble-actions
• on-bubble-conference-actions

Beispiel für on-main-window-actions mit zwei Erweiterungen:

Hauptfelder

• "Name": ist ein Text zur Identifizierung der Aktion oder die Bezeichnung der Schaltfläche für Aktionen, die eine Schaltfläche verwenden
• Für Aktionen, die eine Schaltfläche verwenden:
  • "Symbol": ist der Zugriffspfad zum Symbol der Schaltfläche
  • "tooltip": ist der Zugriffspfad zum Tooltip, der angezeigt wird, wenn die Maus über die Schaltfläche bewegt wird
• "command": definiert die auszuführende Aktion

• "url": ist der Pfad oder die URL zum Zugriff auf die lokale Anwendung, Webseite oder REST API

  Hinweis: Der Backslash muss im Zugriffspfad zur lokalen Anwendung doppelt vorkommen (z.B. C:\\MicroCRM\\MicroCRM.exe).
• "params": ist eine Zeichenkette mit Variablen ${xx}, die bei der Ausführung der Aktion durch ihren Wert ersetzt werden

• "commandType": gibt den Aktionstyp an:

  • Nicht definiert: startet eine lokale Anwendung oder eine Webseite (wenn die Url mit 'http' oder 'https' beginnt)
  • "rest": führt einen REST-API-Anruf aus
  • "file": holt den Inhalt der Datei, die abgeholt werden soll (hauptsächlich für die Debugger-Abstimmung)
  Hinweis: Die Aktionen mit den Befehlstypen "rest" und "file" werden nicht unterstützt, wenn sie auf Web Rainbow Anwendungen angewendet werden. Es öffnen sich Pop-ups, die darauf hinweisen, dass die Aktionen ignoriert werden.

• "responseType: Definiert den Typ des von der Aktion zurückgegebenen Inhalts: "markdown", "json" oder "adaptiveCard".

  Wenn auf "json" gesetzt, dann:

  • "displayJsonField": definiert das Feld, dessen Wert der anzuzeigende Inhalt ist
  • "firstNameJsonField": definiert das Feld, dessen Wert den Vornamen des Anrufers ersetzen soll
  • "lastNameJsonField": definiert das Feld, dessen Wert für den Nachnamen des Anrufers stehen soll
  • "companyJsonField": definiert das Feld, dessen Wert den Namen der Firma des Anrufers ersetzen soll

  Wenn auf "adaptiveCard" gesetzt, dann:

  • "adaptiveCardTemplateJsonField": definiert die Vorlage der adaptiven Karte, die angezeigt werden soll
  • "adaptiveCardContentJsonField": definiert den Inhalt der anzuzeigenden adaptiven Karte

Hauptfelder:

Typ des Inhalts in "json":

Zusätzliche Felder

• "AnswerOnClick": wenn auf "true" gesetzt, wird die Aktion ausgeführt und der eingehende Anruf gleichzeitig beantwortet (nur für die Aktion "on-incoming-pbx-call-buttonactions" )
• "filter": wenn auf "NoShortNumber" gesetzt, wird das Ereignis nicht ausgelöst, wenn die Nummer des Anrufers eine kurze Nummer ist
• "RaiseChangeCall": ermöglicht die Konfiguration des Verhaltens bei der Annahme eines weitergeleiteten Anrufs:

  • false: nur direkte Anrufe an den Benutzer lösen das Ereignis aus

  • true: das Ereignis wird für direkte Anrufe an den Benutzer und auch für Anrufe, die an diesen Benutzer weitergeleitet wurden, ausgelöst

  • only: nur übertragene Anrufe an den Benutzer lösen das Ereignis aus

• "Popup": wenn auf true gesetzt, wird eine Anwendung eines Drittanbieters im rechten Teil der Rainbow-Anwendung angezeigt (nur für die Aktion on-main-window-actions )

Variablen ${xx}

Die Aktionsvorlage kann Variablen ${xx} enthalten, die in den Parametern "url", "params" und "bodyParameters" (für REST API) konfiguriert sind. Sie werden durch ihren Wert ersetzt, wenn die Aktion ausgeführt wird.

Die Variablen ${xx} können sein:

Ein regulärer Ausdruck (d.h. regex) kann auf eine Variable ${xx} angewendet werden.

Die Syntax lautet: ${rainbowVariable.regex(regexPatternValue, replacementValue)}

Der Regex wird auf die Variable ${xx} angewendet, bevor sie an die externe Anwendung gesendet wird, wenn sie Teil der Anfrage ist, oder bevor sie an die Webanwendung übergeben wird, wenn sie Teil einer Antwort ist.

Beispiele:

Wenn ${localUser.phonePbx} durch seinen Wert ersetzt wird, wird auch ein Regex darauf angewendet.

"params": "pbx=${localuser.phonepbx.regex(^\\+33\|^\\+1, 0)}="0)}"

In diesem Beispiel wird "+333909090" in "03909090" geändert.

"params": "byEmail=${localUser.email.regex(alcatel.com, al-enterprise.com)}"

In diesem Beispiel wird "someone@alcatel.com" in "someone@al-enterprise.com" geändert.

Exportieren einer Vorlage der custo-manifest Datei auf dem Computer

Dieser Vorgang kann nur von einer Rainbow Desktop-Anwendung aus durchgeführt werden.

1. Klicken Sie in der Rainbow-Anwendung auf den Avatar im linken Bereich und dann auf das Menü Einstellungen.
2. Wählen Sie im linken Menü Telefonie.
   Das Fenster Einstellungen - Konfiguration der Telefonie wird geöffnet.
3. Erweitern Sie das Fenster bis zum Abschnitt Anpassung.
4. Klicken Sie auf Datei exportieren und verwenden Sie den Browser, um die Datei custo-manifest auf den Computer zu exportieren.
5. Klicken Sie auf Schließen, um das Fenster Telefonie-Einstellungen zu verlassen.

Konfigurieren der custo-manifest Datei auf dem Computer

1. Öffnen Sie die custo-manifest Datei mit einem Texteditor.

2. Konfigurieren Sie die Parameter der zu verwendenden Aktionen.

   Achtung: Löschen Sie nicht den Raum zwischen den doppelten Anführungszeichen für die nicht verwendeten Parameter ("name": " ", "url": " ", "params": " "), sonst wird die importierte Datei nicht berücksichtigt.
3. Entfernen Sie die Parameter aller nicht verwendeten Aktionen.
4. Speichern Sie die custo-manifest Datei.
5. Wenn die custo-manifest Datei auf externe Quellen (Bilder und/oder Textdateien) verweist, erstellen Sie eine *.zip Datei mit der custo-manifest Datei und den externen Quellen.
   Beispiel:
   
   In diesem Beispiel muss die *.ZIP-Datei die Dateien custo-manifest.json, basketball.png und FileDisplay.txt enthalten.

Importieren der custo-manifest Datei zur Verwaltung der Rainbow Anwendung

Sie können eine oder mehrere custo-manifest Dateien in die Rainbow Anwendung für das Unternehmen importieren. Nach dem Import ist die custo-manifest Datei für alle Administratoren des Unternehmens zur Bereitstellung oder Aktualisierung zugänglich.

Der Datei-Import kann von einer Desktop- oder Web-Rainbow-Anwendung aus durchgeführt werden.

1. Klicken Sie in der Rainbow Verwaltungsanwendung im linken Bereich auf Ihr Unternehmen verwalten .
2. Klicken Sie im Bereich MEIN UNTERNEHMEN auf den Namen des Unternehmens.
3. Klicken Sie in der linken Leiste auf Informationen.
4. Im rechten Teil des Fensters klicken Sie auf die Registerkarte Anpassung und dann auf die Registerkarte Benutzerdefinierte Dateien.
5. Klicken Sie auf Hinzufügen und verwenden Sie den Browser, um entweder nur die custo-manifest Datei (*.json) oder die custo-manifest Datei und ihre externen Quellen (*.ZIP) auszuwählen und in die Rainbow Anwendung zu importieren.
6. Klicken Sie auf Hinzufügen, um den Import zu bestätigen.
   Die custo-manifest Datei wird in der Liste angezeigt und kann von jedem Unternehmensadministrator zur Aktualisierung exportiert werden: Wählen Sie die Zieldatei, klicken Sie auf und wählen Sie Download.

Bereitstellen der custo-manifest Datei für Rainbow Anwendungen für Firmenmitglieder

Die Datei custo-manifest kann in den Rainbow-Anwendungen für Firmenmitglieder einzeln oder in einem einzigen Schritt über die Massenbereitstellung bereitgestellt werden. Nach der Bereitstellung wird die custo-manifest-Datei beim Neustart der Rainbow-Anwendungen berücksichtigt: Export-/Importoptionen werden in der Rainbow-Anwendung nicht mehr angeboten.

Mass Provisioning kann mit einer der folgenden Methoden durchgeführt werden:

• Eine CSV-Datei: Der Vorgang besteht darin, die Custo-Manifest-Datei für ein Firmenmitglied bereitzustellen (siehe Verfahren unten), eine CSV-Datei mit den Daten der Firmenmitglieder zu exportieren, in der CSV-Datei die Spalte selectedManifestName für die Zielfirmenmitglieder zu vervollständigen und die CSV-Datei zu importieren: siehe: Verwalten von Firmenmitgliedern mit Bulk Provisioning
• Das LDAP-Verzeichnis des Unternehmens: Der Vorgang besteht darin, das Unternehmensverzeichnis in Rainbow mit dem LDAP-Verzeichnis des Unternehmens zu synchronisieren, nachdem Sie die vordefinierte Attributzuordnung mit dem Benutzerattribut selectedAppCustomisationTemplateName auf const(<Name der custo-manifest Datei>) geändert haben : siehe: Bereitstellung von Unternehmensmitgliedern über ein Active Directory (LDAP Connector)

So verteilen Sie die Datei custo-manifest nacheinander auf die Rainbow Anwendungen:

1. Klicken Sie in der Rainbow-Anwendung Administration im linken Bereich auf Ihr Unternehmen verwalten .
2. Klicken Sie im Bereich MEINE FIRMA auf den Namen des Unternehmens.
3. Klicken Sie in der linken Leiste auf Mitglieder.
4. Klicken Sie auf das gewünschte Firmenmitglied und wählen Sie die Registerkarte Informationen.
5. Wählen Sie im Feld Benutzerdefiniertes Manifest die Zieldatei aus der Liste der verfügbaren Dateien aus.
6. Klicken Sie auf Anwenden, um zu bestätigen und das Fenster Einstellungen für Firmenmitglieder zu verlassen.

1. Klicken Sie in der Rainbow-Anwendung des Unternehmensmitglieds auf den Avatar im linken Bereich und dann auf das Menü Einstellungen.
2. Wählen Sie im linken Menü Telefonie.
   Das Fenster Einstellungen - Konfiguration der Telefonie wird geöffnet.
3. Erweitern Sie das Fenster bis zum Abschnitt Anpassung.
4. Klicken Sie auf Datei importieren und verwenden Sie den Browser, um entweder nur die custo-manifest Datei (*.json) oder die custo-manifest Datei und ihre externen Quellen (*.ZIP) auszuwählen und in die Rainbow Anwendung zu importieren.
5. Klicken Sie auf Weiter, um die Rainbow-Anwendung neu zu starten und die neue Datei zu berücksichtigen.

Entfernen der custo-manifest Datei aus Rainbow Anwendungen für Firmenmitglieder

1. Klicken Sie in der Rainbow-Anwendung auf der linken Seite auf Ihr Unternehmen verwalten .
2. Klicken Sie im Bereich MEINE FIRMA auf den Namen der Firma.
3. Klicken Sie in der linken Leiste auf Informationen.
4. Klicken Sie im rechten Teil des Fensters auf die Registerkarte Anpassung und dann auf die Registerkarte Benutzerdefinierte Dateien für Manifeste.
5. Wählen Sie die gewünschte custo-manifest Datei, klicken Sie auf und wählen Sie Benutzerdefiniertes Manifest entfernen.
   Die custo-manifest Datei wird automatisch aus den Rainbow Anwendungen für Firmenmitglieder entfernt.

Beispiele für die Konfiguration

Führen Sie eine Anwendung oder ein Skript mit Parametern aus

Beispiel 1:

Die Aktion on-incoming-pbx-call-actions führt eine Anwendung (z.B. MicroCrm) mit einem Parameter aus 'params' aus (keine Rückgabe).

"version": "2", "extension-points": { "on-incoming-pbx-call-actions": [ { "name": "Exec CRM", "command": { "url": "C:\\MyApp\\CustoApp\\MicroCRM.exe", "params": "-number ${caller.phoneNumber}" } ],

Beispiel 2:

Die Aktion on-incoming-pbx-call-actions führt ein Skript (*.bat) mit Parametern aus 'params' aus (keine Rückgabe).

"version": "2", "extension-points": { "on-incoming-pbx-call-actions": [ { "name": "BatScript", "command": { "url": "C:\\MyApp\\MyApp.bat", "params": "IN-COMING canNr:${localUser.canonicalNumber} userIntNr:$"{localUser.internalNumber} caller[Nr:${calle.phoneNumber} FN:${caller.firstName} LN:${caller.lastName} .... CorData:[${call.correlatorData Hex:${call.hexCorrelatorData]" }   
  } ],

Öffnen Sie eine Webseite mit Parametern

Beispiel 1:

Die Aktion on-incoming-pbx-call-actions öffnet eine Webseite mit Parametern aus 'params' (keine Rückgabe).

"version": "2", "extension-points": { "on-incoming-pbx-call-actions": [ { "name": "Gelbe Seiten", "command": { "url":"https://www.pagesjaunes.fr/annuaireinverse/recherche", "params": "quoiqui=${caller.phoneNumber}&proximite=0" } } ],

Beispiel 2:

Die Aktion on-incoming-pbx-call-actions öffnet eine Webseite mit Parametern direkt in der URL (kein Return).

"version": "2", "extension-points": { "on-incoming-pbx-call-actions": [ { "name": "Kontakt popup", "command": { "url":"http://localhost:3000/contactShow?phone=${caller.phoneNumber}", "params": " " } } ],

Ausführen eines REST API Anrufs mit Parametern

Beispiel 1:

Wenn ein eingehender Anruf freigegeben wird, erstellt die Aktion on-releasing-incoming-pbx-call-actions ein END-Anrufprotokoll in REST mit der GET-Methode und den Parametern aus "params" (keine Rückgabe).

"version": "2", "extension-points": { "on-releasing-incoming-pbx-call-actions": [ { "name": "GetRestApi", "command": { "commandType": "rest", "method": "GET", "url":"http://localhost:3000/IncidentManager/CreateCallLog", "params": "byEmail=${localUser.email}&CustomerContact=${caller.phonenumber}" } } ],

Beispiel 2:

Wenn ein eingehender Anruf freigegeben wird, erstellt die Aktion on-releasing-incoming-pbx-call-actions ein END-Anrufprotokoll in REST mit der POST-Methode und den Parametern von "bodyParameters" (keine Rückgabe).

"version": "2", "extension-points": { "on-releasing-incoming-pbx-call-actions": [ { "name": "PostRestApi", "command": { "commandType": "rest", "method": "POST", "url":"http://localhost:3000/IncidentManager/EndCallLog", "params": " " }, "bodyParameters": { "caller": "${contact.phoneNumber}", "Benutzer": "${localUser.email}", } ],