Versions Compared

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で詳細を見つけることができます。

拡張はBellaDati機能の一つです。主な目標は以下のことを実行するための顧客に機能を提供することです。

  • カスタムコンテンツとカスタム機能でBellaDatiで直接に新Webページを作成します。
  • look & feelをカスタマイズ及び機能拡張するために、既存BellaDatiページを変更します。
  • BellaDatiトップメニューの下にあるカスタマイズメニューを作成します。

    Note

    Domain AdminまたはSuper Adminしか拡張機能を管理できません

    Extension are enabled by license key.

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

    拡張機能は「Extensionsメニューの下に、「Administration」セクションでご利用いただけます!

    拡張ギャラリー

    拡張ギャラリーページは、ユーザーが次の操作を含む既存の拡張を列記可能です。

    • 上部フィルタコンポーネントのフィルタ拡張ZIPファイルから拡張取込
    • 拡張を有効化と無効化拡張機能にパラメータ設定
    Note

    マルチドメイン環境では、Domain AdminSuper Adminによって作成された拡張機能または別のドメインから拡張機能を管理する権限がありません。

    拡張機能の管理

    Manage extensionsページでは、管理者が以下の操作にすべての既存の拡張機能を管理することができます

    • 上部フィルタコンポーネントのフィルタ拡張
    • 新しい拡張機能ブランチを作成
    • ZIPファイルから拡張取込
    • 拡張機能を編集、有効化、無効化、エクスポートおよび削除
    • 拡張子がすべてのドメインに適用する必要がある場合に設定

    拡張機能作成

    管理者は「Manage extensions」ページ上の「Create extension 」ボタンをクリックして、手動で拡張機能を作成することができます。

    各拡張機能には、唯一の名前と次のいずれかのタイプを持つべきです。(このページの上部にある詳細な説明を参照してください)

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

    拡張は以下の主なパートを含みます:

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

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

    • パラメーター
      • 各拡張は、パラメータ化することができ、これらのパラメータは、あなたのコードにどこにでも使用することができます(HTML, JavaScript, CSSなど)
      • パラメータは、次のコードによって参照することができます。
        • #PARAM=myParamName#
    • Look & Feelの設定
      • アイコンとスクリーンショットはExtension Galleryページに表示されます
    • 説明
      • 豊富なテキストは、Extension Galleryページに表示されます

    拡張の編集

    管理者は、「Manage extensions ページ上の「Edit(鉛筆)ボタンをクリックして、手動で拡張を編集することができます。

    拡張のパッキング

    異なる環境とドメイン間の拡張を移動させるためには、パッケージングを使用することは非常に便利です。取込および出力パッケージする方法を見てみましょう。

    拡張出力

    拡張機能を出力した場合には拡張管理ページで出力オプションを選択します。拡張がzipファイルとしてダウンロードされます。

    拡張子の取込

    拡張を取込むために、拡張管理ページ上の「Import extension 」オプションを選択します。拡張したzipファイルを選択し、「Upload」オプションを選択します。

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

     

    ...