Versions Compared

Old Version 20

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version 21

changes.mady.by.user Kanako Higashi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

Extensions are one of BellaDati feature dedicated to developers. The main goal is to provide ability to:

  • create pretty new web page directly in BellaDati with custom content and custom functionalities
  • modify existing BellaDati page to customize look & feel and extend its functionality
  • create customized menu located below BellaDati's top menu
  • create customized API using server side extensions

 

Tip

Developers can find more in Technical Documentation.

Note

Only Domain Admin or Super Admin can manage extensions.

Extension are enabled by license key.

Extensions support packaging. It means that user can export extension as ZIP file and import it in another domain or another BellaDati instance.

Extensions are available in the Administration section, under Extensions menu.

Extension gallery

Page Extension gallery allows users to list existing extensions including following operations:

  • filter extensions in the top filter component
  • import extension from ZIP file
  • activate and deactivate extensions
  • set parameters for extension

Note

In multi-domain environment Domain Admin does not have permissions to manage extensions from other domains, or extensions created by Super Admin.

Manage extensions

Page Manage extensions allows administrators to manage all existing extensions including following operations:

  • filter extensions in the top filter component
  • create a brand new extension manually
  • import extension from ZIP file
  • edit, activate, deactivate, export and delete extensions
  • set if extension should be applied in all domains

CREATE extension

Administrator can create extension manually by click on the Create extension button on Manage extensions page.

Each extension has to have unique name and one of following types (please see detailed description at the top of this page):

  • Create new page
  • Modify existing page
  • Create custom menu

Extension consists of following main parts:

  • Content of HTML head
    • HTML elements that will be injected into HEAD
  • Content of HTML body
    • HTML elements that will be injected into BODY
  • API Endpoints 
  • Resources
    • Text files (e.g. CSS, JavaScript, JSON) and binary files (e.g. images) that can be used anywhere on the target extension page
    • All JavaScript files will be automatically into HTML head
    • Resources can be referenced by following code:
      • #LINK=myResourceName.js#

Extension has also additional features:

  • Parameters
    • Each extension can be parametrized and these parameters can be used anywhere in your code (HTML, JavaScript, CSS, etc.)
    • Parameters can be referenced by following code:
      • #PARAM=myParamName#
  • Look & Feel settings
    • Icon and screenshot displayed on the Extension Gallery page
  • Description
    • Rich text displayed on the Extension Gallery page

Edit extension

Administrator can edit extension manually by click on the Edit (pencil) button on Manage extensions page.

Packaging of Extensions

In order to move extensions between different environments and domains, it is very convenient to use the packaging. Take a look how to import and export packages.

Exporting Extensions

In case you would like to export the extension, select option export on Extension management page. Extension will be downloaded as a zip file.

Importing Extensions

In order to import the extension, select option Import extension on Extension management page. Select zip file with the extension and select option Upload.

Take a look at use cases with examples of extensions.

 

Sv translation
languageja

拡張機能は、開発者専用のBellaDati機能の1つです。主な目標は、次の機能を提供することです:

  • カスタムコンテンツとカスタム機能を使用して、BellaDatiで新しいWebページを直接作成します。
  • 既存のBellaDatiページを変更してルックアンドフィールをカスタマイズし、機能を拡張します。
  • BellaDatiのトップメニューの下にカスタマイズされたメニューを作成します。
  • サーバー側拡張機能を使用してカスタマイズされたAPIを作成します。

Tip

開発者は、Technical Documentationで詳細を見つけることができます。

Note

拡張機能を管理できるのは、ドメイン管理者またはSuper Adminのみです。

拡張機能はライセンスキーによって有効になります。

拡張機能はパッケージングをサポートします。ユーザーが拡張機能をZIPファイルとしてエクスポートし、別のドメインまたは別のBellaDatiインスタンスにインポートできることを意味します。

拡張機能は、[管理]セクションの[拡張機能]メニューにあります。

拡張ギャラリー

拡張機能ギャラリーページを使用すると、ユーザーは次の操作を含む既存の拡張機能を一覧表示できます:

  • 上部フィルターコンポーネントのフィルター拡張機能

  • ZIPファイルから拡張子をインポートする

  • 拡張機能の有効化と無効化

  • 拡張機能のパラメーターを設定する

Note

マルチドメイン環境では、ドメイン管理者には他のドメインからの拡張機能、またはSuper Adminが作成した拡張機能を管理する権限がありません。

拡張機能の管理

「拡張機能の管理」ページにより、管理者は次の操作を含むすべての既存の拡張機能を管理できます:

  • 上部フィルターコンポーネントのフィルター拡張機能
  • 新しい拡張機能を手動で作成する
  • ZIPファイルから拡張機能をインポートする
  • 拡張機能の編集、有効化、無効化、エクスポート、削除
  • 拡張機能をすべてのドメインに適用するかどうかを設定する

拡張機能の作成

管理者は、[拡張機能の管理]ページの[拡張機能の作成]ボタンをクリックして、拡張機能を手動で作成できます。


各拡張機能には、一意の名前と次のいずれかのタイプが必要です（このページの上部にある詳細な説明を参照してください）:

  • 新しいページを作成
  • 既存のページを変更
  • カスタムメニューを作成

拡張機能は、次の主要部分で構成されています:

  • HTMLヘッドのコンテンツ
    • HEADに挿入されるHTML要素
  • HTML本文のコンテンツ
    • 本文に挿入されるHTML要素
  • APIエンドポイント
  • リソース
    • ターゲット拡張機能ページのどこでも使用できるテキストファイル　(CSS, JavaScript, JSONなど)とバイナリファイル　(画像など)
    • すべてのJavaScriptファイルは、自動的にHTMLヘッドになります
    • リソースは、次のコードで参照することができます:
      • #LINK=myResourceName.js#

拡張機能には追加機能もあります:

  • パラメーター
    • 各拡張機能はパラメーター化でき、これらのパラメーターはコードの任意の場所で使用できます（HTML、JavaScript、CSSなど）。
    • パラメーターは次のコードで参照できます:
      • #PARAM=myParamName#
  • Look & Feelの設定
    • 拡張機能ギャラリーページに表示されるアイコンとスクリーンショット
  • 説明
    • 拡張機能ギャラリーページに表示されるリッチテキスト

拡張の編集

管理者は、[拡張機能の管理]ページの[編集]（鉛筆）ボタンをクリックして、拡張機能を手動で編集できます。

拡張機能のパッケージング

異なる環境とドメイン間で拡張機能を移動するには、パッケージを使用すると非常に便利です。パッケージをインポートおよびエクスポートする方法を見てください。

拡張機能のエクスポート

拡張機能をエクスポートする場合は、拡張機能管理ページでエクスポートオプションを選択します。拡張機能はzipファイルとしてダウンロードされます。

拡張機能のインポート

拡張機能をインポートするには、[拡張機能管理]ページで[拡張機能のインポート]オプションを選択します。拡張機能を含むzipファイルを選択し、[アップロード]オプションを選択します。

拡張の例について拡張の例とともにユースケースを見てみましょう。 を見てください。

Sv translation
languagede

Erweiterungen sind eine der Funktionen von BellaDati für Entwickler. Das Hauptziel ist es, die Fähigkeit zu vermitteln:

  •  Erstellen Sie eine neue Webseite direkt in BellaDati mit benutzerdefinierten Inhalten und benutzerdefinierten Funktionalitäten.  
  • Ändern Sie die bestehende BellaDati-Seite, um das Look & Feel anzupassen und die Funktionalität zu erweitern.  
  • Erstellen Sie ein individuelles Menü, das sich unter dem Top-Menü von BellaDati befindet.  
  • Erstellen Sie ein benutzerdefinierten API mit serverseitigen Erweiterungen 

 

Tip

Entwickler finden mehr in der Technischen Dokumentation.

Note

Nur der Domain-Administrator oder Super-Admin kann Erweiterungen verwalten.

Die Erweiterung wird durch den Lizenzschlüssel aktiviert.

Erweiterungen unterstützen die Paketierung. Das bedeutet, dass der Benutzer die Erweiterung als ZIP-Datei exportieren und in eine andere Domäne oder eine andere BellaDati-Instanz importieren kann.

Erweiterungen sind im Abschnitt Administration unter dem Menüpunkt Erweiterungen verfügbar.

Galerie für Erweiterungen

Die Galerie für Seiten-Erweiterungen ermöglicht es Benutzern, bestehende Erweiterungen einschließlich folgender Operationen aufzulisten:

  • Filtererweiterungen in der oberen Filterkomponente
  • Importerweiterung aus der ZIP-Datei
  • Erweiterungen aktivieren und deaktivieren
  • Parameter für die Erweiterung einstellen
Note

In einer Multi-Domain-Umgebung hat der Domain Admin keine Berechtigung, Erweiterungen aus anderen Domänen oder von dem Super Admin erstellte Erweiterungen zu verwalten.

Erweiterungen verwalten

Seitenverwaltungs-Erweiterungen ermöglichen es Administratoren, alle vorhandenen Erweiterungen zu verwalten, einschließlich der folgenden Operationen:

  • Filtererweiterungen in der oberen Filterkomponente
  • Eine brandneue Erweiterung manuell erstellen
  • Importerweiterung aus der ZIP-Datei
  • Erweiterungen bearbeiten, aktivieren, deaktivieren, exportieren und löschen
  • Legt fest, ob die Erweiterung in allen Domänen angewendet werden soll.

Erweiterungungen erstellen

Der Administrator kann die Erweiterung manuell erstellen, indem er auf der Seite Erweiterungen verwalten auf die Schaltfläche Erweiterung erstellen klickt.

Jede Erweiterung muss einen eindeutigen Namen und einen der folgenden Typen haben (siehe detaillierte Beschreibung oben auf dieser Seite):

  • Neue Seite erstellen
  • Vorhandene Seite ändern
  • Benutzerdefiniertes Menü erstellen

Die Erweiterung besteht aus den folgenden Hauptteilen:

  • Inhalt des HTML-Headers
    • HTML-Elemente, die in HEAD eingefügt werden.
  • Inhalt des HTML-Bodys
    • HTML-Elemente, die in BODY eingefügt werden.

  • API-Endpunkte

  • Ressourcen
    • Textdateien (z.B. CSS, JavaScript, JSON) und Binärdateien (z.B. Bilder), die überall auf der Ziel-Erweiterungsseite verwendet werden können.
    • Alle JavaScript-Dateien werden automatisch in den HTML-Kopf übernommen.
    • Ressourcen können durch folgenden Code referenziert werden:
      • #LINK=myResourceName.js#

Die Erweiterung hat auch zusätzliche Funktionen:

  • Parameter
    • Jede Erweiterung kann parametrisiert werden und diese Parameter können überall in Ihrem Code verwendet werden (HTML, JavaScript, CSS, etc.).
    • Parameter können durch folgenden Code referenziert werden:
      • #PARAM=myParamName#
  • Look & Feel-Einstellungen
    • Symbol und Screenshot auf der Seite Erweiterungsgalerie angezeigt.
  • Beschreibung
    • Rich-Text, der auf der Seite Erweiterungsgalerie angezeigt wird.

Erweiterung bearbeiten

 Der Administrator kann die Erweiterung manuell bearbeiten, indem er auf der Seite Erweiterungen verwalten auf die Schaltfläche Bearbeiten (pencil) klickt.

Verpacken von Erweiterungen

Um Erweiterungen zwischen verschiedenen Umgebungen und Domänen zu verschieben, ist es sehr praktisch, das Packaging zu verwenden. Werfen Sie einen Blick darauf, wie man Pakete importiert und exportiert.

Erweiterungen exportieren

Wenn Sie die Erweiterung exportieren möchten, wählen Sie die Option export auf der Seite Extension Management. Die Erweiterung wird als Zip-Datei heruntergeladen.

Erweiterungen importieren

Um die Erweiterung zu importieren, wählen Sie die Option Erweiterung importieren auf der Seite Erweiterungsverwaltung. Wählen Sie die Zip-Datei mit der Erweiterung und wählen Sie die Option Hochladen.

Werfen Sie einen Blick auf Anwendungsfälle mit Beispielen für Erweiterungen.