Versions Compared

Key

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

Extensions are one of BellaDati feature. The main goal is to provide ability for customers 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
Note

Only Domain Admin or Super Admin can manage extensions.

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.

Image Modified

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.

Image Modified

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
Note

In multi-domain environment only Super Admin has permissions to access this page and manage extensions.

Image Modified

CREATE extension

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

Image Modified

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
  • 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.

Image Modified

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.

Image Modified

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.

Image Modified

Take a look at use cases with examples of extensions.

 

Sv translation
languageja

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

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

専用ドメイン管理者またはスーパー管理者は拡張機能を管理できる。

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

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

Image Added

拡張ギャラリー

拡張ギャラリーページは、ユーザーが次の操作を含む既存の拡張を列記できる:

  • トップフィルタ部品に拡張をフィルタ
  • ZIPファイルから拡張インポート
  • 活性化し、拡張機能を無効化
  • 拡張機能にパラメータ設定
Note

マルチドメイン環境では、ドメイン管理者スーパー管理者によって作成された拡張機能または別のドメインから拡張機能を管理する権限がない。

Image Added

拡張機能の管理

Manage extensionsページでは、管理者がすべての既存の拡張機能を管理できる。次の操作を含む。

  • トップフィルタ部品に拡張をフィルタ
  • 手動で新しい拡張機能を作成する
  • ZIPファイルから拡張インポート
  • 拡張機能を編集、アクティブ化、非アクティブ化、エクスポートおよび削除
  • 拡張子がすべてのドメインに適用されなければならない場合に設定
Note

マルチドメイン環境でスーパー管理者のみはこのページにアクセスし、拡張機能を管理の権限を持っている。

Image Added

拡張機能を作成

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

Image Added

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

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

拡張は以下の主なパートを含む。

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

拡張は追加機能もある。

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

拡張の編集

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

Image Added

拡張のパッキング

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

拡張のエクスポート

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

Image Added

拡張子のインポート

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

Image Added

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

 

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