Skip to main content
カスタムコンポーネントの開発には一定の開発知識が必要です。開発者、ISV プロバイダー、および上級業務エキスパートを対象としています。

概要

カスタムコンポーネントとは

カスタムコンポーネント機能により、お客様が独自のコンポーネントを作成できます。コンポーネントと業務ニーズの適合性を高めつつ、開発・保守コストを削減し、コンポーネントの再利用性を向上させます。

ユースケース

標準の YiDA コンポーネントではアプリ開発の業務ニーズを満たせない場合、業界ごとのベストプラクティスや要件に基づいて、業務シナリオに合わせたコンポーネントを開発できます。カスタムコンポーネントは同一組織内で共有できるため、類似のアプリを後で開発する際に関連コンポーネントを簡単に再利用できます。

コンポーネントの構成

コンポーネントはビューと属性で構成されます。利用側では、コンポーネントの属性を変更することで異なるビューを表示できます。 ビューはさらに、デザインビューとランタイムビューに分かれます。通常、デザインビューとランタイムビューは共用可能です。 制作側では、コンポーネントのビューと属性をそれぞれ個別に構築する必要があります。

カスタムコンポーネントの Schema のインポート

例のセクションでは、複数のカスタムコンポーネントの例を提供しています。開発者は以下の手順に従って、例の Schema を独自のカスタムコンポーネントにインポートし、業務で活用できます。

手順 1:カスタムコンポーネントの作成

こちらのドキュメントに従って、例の Schema をインポートするためのカスタムコンポーネントを作成します。

手順 2:YiDA Schema ワークベンチを開いて Schema をインポート

カスタムコンポーネントのデザイナーに入り、こちらのドキュメントの手順に従って Schema ワークベンチを開きます。カスタムコンポーネントの Schema を Schema ワークベンチにコピーし、「Schema をインポート」をクリックします。

手順 3:インストールと利用

これでカスタムコンポーネントの作成は完了です。続いてこちらのドキュメントに従って、カスタムコンポーネントをインストールして利用できます。

付録

コンポーネントのタイプ

YiDA のカスタムコンポーネントは、通常コンポーネントフォームコンポーネントの 2 種類に分類されます。主な違いは次のとおりです。
  1. 通常コンポーネントは表示用途で使用され、データストレージには対応していません。既存の「テキスト・画像表示」や「グループ分け」コンポーネントが該当します。
  2. フォームコンポーネントはデータの送信に使用できます。通常コンポーネントよりも開発が複雑で、追加のメタデータ設定が必要です。
  3. フォームコンポーネントは現在未提供です。今後の提供にご期待ください。

コンポーネントのインストールタイプ

YiDA では、次のページタイプを提供しています。通常フォームページ、ワークフローフォームページ、レポートページ、DataV ダッシュボード、カスタムページ、外部リンクの 6 種類です。 YiDA のカスタムコンポーネントは現在、このうち通常フォームページ、ワークフローフォームページ、カスタムページの 3 種類に対応しています。 インストール時に対応するページタイプを選択すると、インストールしたコンポーネントが対応するページデザイナーに表示されます。

コンポーネントバージョンについて

YiDA のカスタムコンポーネントには、開発バージョン正式バージョンの 2 種類があります。 セマンティックバージョニングをベースに、独自の規約を追加しています。
  1. 0.1.0 はデフォルトの開発バージョンです。開発バージョンはコンポーネントデザイナーとリアルタイムで同期され、デバッグに使用します。
  2. 1.x.x は本番環境向けにリリースされる正式バージョンです。現在のバージョンの機能をロックし、本番環境におけるコンポーネントの安定性を保証します。そのため、本番アプリには必ずリリース済みの 1.x.x 正式バージョンをインストールしてください。