カスタムダッシュボードウィジェットのビルド
ガイド
概要
前書き
ビジネスアナリストまたはビジネスルール開発者は、Page Editor ツールを使用してページを設計および定義し、そのページに表示される情報を指定します。どのコンポーネントをページに追加するかを指定できます。また、要件に応じてコンポーネントのプロパティーをカスタマイズできます。任意で、ページを作成する前に、ページのレポーティングコンポーネントをフィードするデータセットを定義できます。
前提条件
- ページを作成するのに十分なパーミッションがある。
第1章 データセットのオーサリング
データセットは情報の関連セットの集まりです。データベース、Microsoft Excel ファイル、メモリーなど、さまざまな方法で保存できます。データセット定義は、Business Central メソッドにデータセットへのアクセス、読み取り、および解析を指示します。Business Central はデータを保存しません。データが保存される場所にかかわらず、データセットへのアクセスを定義できます。
たとえば、データベースにデータが保存されると、有効なデータセットには、SQL クエリーの結果として、データベース全体またはデータベースのサブセットが含まれます。いずれの場合も、データは、情報を表示する Business Central のレポーティングコンポーネントの入力情報として使用されます。
データセットにアクセスするには、データセット定義を作成および登録する必要があります。このデータセットの定義では、データセットの場所と、その場所へのアクセス、読み取り、および解析の方法、ならびにデータセットが含まれるコラムを指定します。
Data Sets ページは、admin ロールを持つユーザーにのみ表示されます。
1.1. データセットの追加
外部データソースからデータを取得して、レポーティングコンポーネントでデータを使用するデータセットを作成できます。
手順
- Business Central で、Admin → Data Sets に移動します。Data Set Explorer ページが開きます。
New Data Set をクリックして、以下のプロバイダータイプから 1 つ選択します。
- Bean: Java クラスからデータセットを生成するのに使用します。
- CSV: リモートまたはローカルの CSV ファイルからデータセットを生成するのに使用します。
- SQL: ANSI-SQL 準拠データベースからデータセットを生成するのに使用します。
- Elastic Search: Elastic Search ノードからデータセットを生成するのに使用します。
Execution Server: Execution Server のカスタムのクエリー機能を使用してデータセットを生成します。
注記KIE Server は、このオプションを使用して設定する必要があります。
Data Set Creation Wizard を完了し、Test をクリックします。
注記設定手順は、選択するプロバイダーにより異なります。
- Save をクリックします。
1.2. データセットの編集
既存のデータセットを編集し、レポーティングコンポーネントに取得したデータが最新になっていることを確認します。
手順
- Business Central で、Admin → Data Sets に移動します。Data Set Explorer ページが開きます。
- Data Set Explorer ペインで、編集するデータセットを検索し、Edit をクリックします。
Data Set Editor ペインで、適切なタブを使用して必要に応じてデータを編集します。タブは、選択するデータセットプロバイダーの種類によって異なります。
たとえば、CSV データプロバイダーの編集には、以下の変更が適用できます。
- CSV Configuration: データセット定義の名前、ソースファイル、区切り記号などのプロパティーを変更できます。
Preview: データのプレビューを使用できます。CSV Configuration タブで Test をクリックすると、システムはデータセットのルックアップコールを実行し、データが利用可能な場合はプレビューが表示されます。Preview タブには 2 つのサブタブがあります。
- Data columns: どの列をデータセット定義に追加するかを指定できます。
- Filter: 新しいフィルターを追加できます。
Advanced: 以下の設定を管理できます。
- Caching: 詳細は 「キャッシュ」 を参照してください。
- Cache life-cycle: データセット (またはデータ) を再読み込みされるまでの間隔を指定できます。バックエンドデータに変更が加えられると、Refresh on stale data 機能は、キャッシュしたデータを再読み込みします。
- 必要な変更を行ったら、Validate をクリックします。
- Save をクリックします。
1.3. データの再読み込み
データの再読み込み機能を使用すると、データセット (またはデータ) を再読み込みされるまでの間隔を指定できます。バックエンドデータに変更が加えられると、Refresh on stale data 機能は、キャッシュしたデータを再読み込みします。
1.4. キャッシュ
Business Central は、インメモリーデータを使用してデータセットを保存し、データ操作を実行するキャッシュメカニズムを提供します。データのキャッシュにより、ネットワークトラフィック、リモートシステムのペイロード、処理時間が減ります。パフォーマンスの問題を回避するには、Decision Central にキャッシュを設定します。
データセットを生成するデータルックアップ呼び出しの場合、キャッシュメソッドは、データルックアップ呼び出しが実行される場所と結果のデータセットが格納される場所を決定します。データのルックアップコールの例としては、ロケールパラメーターを Urban として設定するすべての住宅ローンアプリケーションが挙げられます。
Business Central データセット機能には、キャッシュレベルが 2 つあります。
- クライアントレベル
- バックエンドレベル
クライアントキャッシュ
キャッシュを有効にすると、データセットはルックアップ操作時に Web ブラウザーにキャッシュされ、その後のルックアップ操作ではバックエンドへの要求が実行されません。グループ化、集計、フィルターリング、並べ替えなどのデータセット操作は Web ブラウザーで処理されます。クライアントのキャッシュは、データセットのサイズが小さい場合 (例: データが 10 MB より少ない) にのみ有効になります。データセットが大きい場合は、パフォーマンスの低下や断続的なフリーズなどのブラウザー問題が発生する場合があります。クライアントのキャッシュは、ストレージシステムへの要求などの、バックエンド要求の数を減らします。
バックエンドキャッシュ
キャッシュが有効な場合に、デシジョンエンジンはデータセットをキャッシュします。これにより、リモートのストレージシステムへのバックエンドの要求数が減ります。データセットの全操作は、インメモリーデータを使用してデシジョンエンジンで実行されます。バックエンドキャッシュは、データセットのサイズが頻繁に更新され、インメモリーに保存されて処理される場合に限り有効です。バックエンドキャッシングは、リモートストレージを使用した低レイテンシー接続問題が発生している状況でも有用です。
バックエンドキャッシュの設定は、Data Set Editor の Advanced タブに常に表示されるわけではありません。これは、インメモリーデシジョンエンジンでデータのルックアップ操作を解決するのに、Java および CSV のデータプロバイダーはバックエンドキャッシュに依存するためです (データセットはメモリー内に存在する必要があります)。
第2章 ページのオーサリング
ページは、パースペクティブとしても知られていますが、以下のコンポーネントの集まりです。
- コアコンポーネント
- ナビゲーションコンポーネント
- レポーティングコンポーネント
ページには、コンポーネントをいくつでも追加できますが、必ずしも追加する必要はありません。Page Editor ツールを使用してページを編集します。
ページには、Fluid スタイルまたは Page スタイルのいずれかがあります。Fluid スタイルは標準的な Web ページで、ページの縦の長さが表示できる長さを超えた場合は垂直スクロールバーが使用されます。Page スタイルの Web ページは、縦の長さが常にウィンドウの長さに一致します。
2.1. ページの作成
Pages パースペクティブを使用して、異なる種類のコンポーネントで設定されるページを作成できます。ページを作成し、すべてのコンポーネントをページに定義したら、Page Editor を使用して、必要に応じてページの保存、削除、名前変更、またはコピーを行います。
以下の手順は、ページの作成方法と、必要なコンポーネントをページに追加する方法を説明します。
手順
- Business Central で、Menu → Design → Pages に移動します。
- Pages パネルで、New をクリックします。または、Page Editor ペインで New Page をクリックします。
- New Page ダイアログボックスでの Name フィールドに値を入力し、必要なスタイルを選択します。
- OK をクリックします。Page Editor に新しいページが開きます。
- Components ペインで、コンポーネントを展開し、必要なコンポーネントタイプをエディターのキャンバスにドラッグします。
- ページにコンポーネントを配置したら、Properties ペインからプロパティーを編集します。
- Save をクリックし、再度 Save をクリックします。
2.2. ページの保存、削除、名前変更、またはコピー
ページを作成して定義したら、必要に応じて Page Editor を使用してページの保存、削除、名前変更、またはコピーします。
手順
- Business Central で、Menu → Design → Pages に移動します。
- Pages パネルからページを選択します。Page Editor にページが開きます。
- 必要な操作を実行し、Page Editor の右上から Save、Delete、Rename、または Copy を選択します。
図2.1 ページの保存、削除、名前変更、またはコピー
2.3. ナビゲーションツリー
Workbench ナビゲーションツリーには、Business Central の Main メニューに表示されるエントリーが含まれます。このナビゲーションツリー構造への変更は、ホームページの Main メニューに反映されます。このメカニズムは、新しいページの公開などに使用できます。
また、追加のナビゲーションツリーを作成できます。このカスタムツリーを使用して、ページ内にナビゲーションコンポーネントを設定できます。Navigation パネルから Workbench ツリーを削除できませんが、要件に合わせて Workbench ツリー階層の編集は可能です。この機能を使用すれば、新しいページを使用して Business Central の Main メニューをカスタマイズできます。
Navigation パネルにデフォルトで表示される Workbench ツリーは、Business Central のメイン メニュー です。
2.4. コンポーネント
ページには、さまざまなコンポーネントが含まれます。ページには、以下のコンポーネントタイプを使用できます。
- Core コンポーネント: カスタムの HTML 情報を指定、または既存ページを表示するのに使用します。コアコンポーネントは 2 種類があります。
表2.1 Core コンポーネントのサブタイプ
| Core コンポーネントのサブタイプ | 説明 |
|---|---|
| HTML | このコンポーネントは、HTML エディターウィジェットを開きます。テキスト、イメージ、テーブル、リンク、色などを使用して HTML ページを作成します。要件に応じてページをカスタマイズできます。 |
| Page | このコンポーネントを使用すると、新しいダッシュボードに以前作成したページを追加できます。このコンポーネントを使用して、ダッシュボードに作成してあるカスタムページをネストできます。 |
コアコンポーネントは必須ではありません。
- Navigation コンポーネント: ページ間を移動するのに使用します。ナビゲーションコンポーネントの種類は 6 つあります。
表2.2 ナビゲーションコンポーネントのサブタイプ
| ナビゲーションコンポーネントのサブタイプ | 説明 |
|---|---|
| Target Div | このコンポーネントは、タブリスト、メニューバー、ツリーナビゲーターコンポーネントが、エントリーを表示し、クリックした最後の項目を追跡するのに使用します。 |
| Menu Bar | このコンポーネントは、メニューバーの形でナビゲーションツリーのエントリーを表示します。Business Central でサポートされるレベルの数には制限がありません。 |
| Tile Navigator | このコンポーネントは、タイルの形でナビゲーショングループを表示します。グループはディレクトリーとして表示されますが、エントリーが 1 つしかない場合は選択するとそのコンテンツが表示されます。 |
| Tree | このコンポーネントは、垂直のツリー構造フォーマットでエントリーを表示します。 |
| Carousel | 円形やスライドショーなどで選択したページを表示するか、循環させます。 |
| Tab List | このコンポーネントは、コンポーネントの上部に、選択したメニューページをタブとして表示します。 |
ターゲットの Div 設定は、円形、タイルナビゲーターなどの非ターゲット Div コンポーネントには必要 ありません。
レポート コンポーネント： グラフ、テーブル、マップなどの形式でデータセットからデータの表示に使用されます（ Data sets authoring セクションを参照）。レポーティングコンポーネントのタイプは 10 種類あります。レポーティングコンポーネントは New Displayer ウィジェットを使用して設定できますが、ウィジェットには以下の 3 つのタブが含まれます。
- Type: カスタムデータをグラフィカルに表示する方法を選択します。
- Data: Settings メニューで利用可能な Data Sets セクションから作成したカスタムのデータセットの一覧から、データセットを選択します。
- Display: タイトルを追加し、色、サイズなどを変更することでコンテンツを表示する方法を編集してカスタマイズします。
2.4.1. ページエディターにコンポーネントを配置してページの作成
ページを作成するには、Pages パースペクティブの Editor キャンバスにコンポーネントをドラッグする必要があります。ページに必要なコンポーネントをすべて配置したら、Save をクリックします。
2.4.2. Preview タブを使用してページのプレビュー
ページの作成時または編集時に、Page Editor の Preview タブをクリックして、保存する前にページをプレビューします。
2.4.3. コンポーネントのプロパティー
ページに使用されるコンポーネントには、コンポーネントに関連するさまざまなプロパティーが含まれます。Properties パネルで以下のプロパティーを編集して、コンポーネントをカスタマイズできます。
- Panel プロパティー: Width、Height、Background Color など、コンポーネントパネルプロパティーをカスタマイズするのに使用します。
- Margin プロパティー: Top、Bottom、Left、Right など、コンポーネントのマージンプロパティーをカスタマイズするのに使用します。
- Padding プロパティー: Top、Bottom、Left、Right などのコンポーネントパディングプロパティーをカスタマイズするのに使用します。
また、HTML コンポーネントには、コンポーネントの Alignment、Decoration、Color、Size、および Weight プロパティーをカスタマイズする追加テキストプロパティーもあります。
第3章 セキュリティー管理
Security management ページからセキュリティーおよびパーミッション管理タスクを実行できます。Security management ページにアクセスするには、画面の右上隅の Admin アイコンを選択して、Business Central Settings ページの Roles、Groups、または Users を選択します。クリックするアイコンによって、該当のタブに Security management ページが表示されます。ロールおよびグループを使用して、ユーザーの特権および設定を管理します。変更があれば、影響のあるロールまたはグループが割り当てられているすべてのユーザーに適用されます。
3.1. ユーザーの作成
ユーザーの権限および設定は、ユーザーに割り当てたロールと、ユーザーが属するグループで制御されます。Business Central で、ユーザーをいくつでも作成できます。
プロセスエンジンまたは KIE Server で unknown という名前のユーザーは作成しないでください。unknown ユーザーアカウントは、superuser のアクセス権限があるシステム名用に予約されています。unknown ユーザーアカウントでは、ログインしているユーザーがない場合に、SLA 違反リスナーに関連するタスクを実行します。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Users を選択します。
- New user をクリックし、ユーザー名を入力し、Next をクリックします。
- ユーザーにロールを割り当てるには、Roles タブをクリックして、Add Roles をクリックし、任意のロールを選択してから、Add to selected roles をクリックします。
- 必要に応じて、ユーザーにグループを割り当てるには、Groups タブをクリックして Add to groups をクリックし、任意のグループを選択してから Add to selected groups をクリックします。
- Create をクリックします。
- Yes をクリックして、ユーザーにパスワードを設定し、Change をクリックします。
ユーザーが Business Central にアクセスするために 1 つ以上のロールが必要です。
3.2. グループの作成
グループを使用すれば、ユーザーの集まりに特権および設定を制御できます。必要な数だけグループを作成できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Groups を選択します。
- New group をクリックし、グループ名を入力し、Next をクリックします。
このグループに追加するユーザーを選択し、Add selected users をクリックします。
新規作成したグループは、All groups に表示されます。
3.3. グループおよびロールのパーミッションの変更
個人ユーザーに対するパーミッションは変更できません。ただし、グループおよびロールのパーミッションは変更できます。変更したパーミッションは、変更したロールが割り当てられているか、変更したグループに所属するユーザーに適用されます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択します。
- Roles または Groups をクリックして、適切なリストを表示します。
- リストから編集するロールまたはグループをクリックします。全詳細が右側のペインに表示されます。
- Settings セクションの Home Page または Priority を設定します。
Permissions セクションで、Business Central、ページ、エディター、スペース、プロジェクトのパーミッションを設定します。
変更するパーミッションのリソースタイプを展開できます。
必要に応じて、表示されていないアイテムを追加するには、Add Exception をクリックしてから、必要なパーミッションを設定します。
注記Business Central のリソースタイプには、例外を追加できません。
- Save をクリックします。
ロールまたはグループへの変更は、そのロールまたはグループに関連のあるユーザーに加えられます。
ユーザーが同じ優先度を持つ複数のグループのメンバーで、グループに競合するパーミッション設定がある場合、正のパーミッションは負のパーミッションを上書きします。Business Central でパーミッションの設定を確認するには、右上隅の Admin アイコンをクリックして Users を選択し、各ユーザーのグループ割り当ておよびパーミッションを表示します。
3.4. ホームページの変更
ホームページは、Business Central にログインすると表示されるページです。デフォルトでは、ホームページは Home に設定されます。ロールおよびグループのホームページを変更します。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Roles または Groups を選択します。
- ロールまたはグループを選択します。
- Home Page リストからページを選択します。
Save をクリックします。
注記そのロールまたはグループには、ページをホームページにする前に、そのページへの読み取りアクセスが必要です。
3.5. 優先順位の設定
ユーザーは、複数のロールを持ち、複数のグループに所属します。優先順位の設定は、ロールまたはグループの優先順を決定します。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Roles または Groups を選択します。
- ロールまたはグループを選択します。
- 優先順位メニューから優先順位を選択し、Save をクリックします。
ユーザーに、設定が競合するロールが割り当てられているか、グループに所属している場合は、一番高い優先順位を持つロールまたはグループを設定します。
第4章 カスタムのダッシュボードウィジェットの作成
カスタムのダッシュボードを作成するために、Business Central の機能の一部 (データセット、ページ、ナビゲーションツリー、パーミッションなど) を組み合わせて公開する必要があります。ダッシュボードは、最低でも 1 つのレポーティングコンポーネントが含まれるページです。
カスタムのダッシュボードの作成には 4 つのステージがあります。
- データセットオーサリング: このステージでは、ページを介してデータにアクセスして表示するデータセットを定義します。詳細は、「 データセットの追加 」を参照してください。
- ページオーサリング: このステージでは、データセットからデータを表示するのに使用されるページを作成します。詳細は ページの作成 を参照してください。
- 公開: このステージでは、カスタムのナビゲーションツリーを作成、または既存のデフォルトナビゲーションツリー (Workbench ツリー) を修正する際に、ページ間の移動が定義されます。詳細は ナビゲーションツリーの作成 または ナビゲーションツリーの編集 を参照してください。
- セキュリティー管理: このステージでは、Business Central で作業中にユーザーが所有する特権を定義するロールおよびグループのパーミッションが設定されます。詳細は、「 セキュリティー管理」を参照し てください。
Business Central の以前のバージョンから最新のバージョンにダッシュボードの移行を計画する場合は、上述のステージに従う必要があります。この時に有用な自動移行パスまたはツールはありません。ダッシュボードは最初から作り直す必要があります。
付録A バージョン情報
本書の最終更新日： 2022 年 3 月 8 日（火）
