モジュールビルダー

1. 概要

モジュールビルダーを使ってカスタムモジュールを作成することができます。また、モバイルレイアウトオプションを使用し、カスタムモジュールをモバイルで見ることができます。

カスタムモジュールを作成するためのプロセスは以下の通りです。

1. 新しいモジュールを格納するパッケージを作成します。パッケージの中には複数のモジュールを格納することができます。

2. 以下のSugarが提供するテンプレートタイプから1つを指定してモジュールを作成します。

ベーシック:このテンプレートはIDや作成日、作成者といった、基本的なフィールドを提供します。このテンプレートを使用し、一からモジュールを作成します。

 会社情報:このテンプレートは会社名や業界、請求先住所といった、会社に関連したフィールドを提供します。このテンプレートを使用し、取引先モジュールに似たモジュールを作成します。

 ファイル:このテンプレートはファイル名のような、ドキュメントの情報に必要なフィールドを提供します。このテンプレートを使用し、ドキュメントモジュールに似たモジュールを作成します。

 ケース:このテンプレートはIDや詳細、作成者といった、ケースやバグトラッカーの情報に必要なフィールドを提供します。このテンプレートを使用し、ケースやバグトラッカーに似たモジュールを作成します。

 担当者:このテンプレートは職位や姓名、住所、電話番号といった、個人の情報に必要なフィールドを提供します。このテンプレートを使用し、取引先担当者やリードに似たモジュールを作成します。

 セールス:このモジュールはリードソースや確度といった、商談に必要なフィールドを提供します。このテンプレートを使用し、商談モジュールに似たモジュールを作成します。

3. 必要に応じて新しいフィールドを作成します。また、テンプレートにあるデフォルトのフィールド名を変更することもできます。

:テンプレートにあるフィールドのプロパティは、フィールド名以外は変更することはできません。ただし、それらのフィールドを複製・リネーム・カスタマイズすることができます。

4. 必要に応じて、一覧ビューや編集ビュー、詳細ビュー、サブパネル、検索フォーム、Sugarダッシュレットのレイアウトをカスタマイズします。

5. 必要に応じて、新しいモジュールと他のモジュールの関連を作成します。一般的にSugarのモジュールは複数のモジュールと関連があります。カスタムモジュールを作成する際に、他のSugarモジュールとの関連を定義することができます。

6. パッケージを保存し、配置します。


パッケージを配置する際に、以下のオプションから一つ選択します。

  公開:特定のユーザや顧客にパッケージを配布するためのオプションです。Sugarはパッケージのzipファイルを作成するので、それをローカル環境に保存し、一人または複数の相手にEメールなどで配布します。受信者はモジュールローダーを使用し、zipファイルを自身のSugar環境へアップロードすることができます。

スタジオからモジュールをインストールした後、公開したモジュールに対してフィールドの追加や削除、そのほかの変更を行うことができます。

  配置:カスタムモジュールを作成したSugar環境内にインストールし、自組織内のユーザに対して使用できるようにするオプションです。配置後には必要に応じて、モジュールビルダーでモジュールをさらに変更し、再配置することでインストールしたモジュールを更新することができます。

また配置したモジュールに対して、スタジオでフィールドの追加や削除、その他の変更を行うこともできます。ただし、配置したカスタムモジュールをスタジオで変更した後に、モジュールビルダーで再配置を行うと、以下の情報が失われることに注意してください。

 スタジオでカスタマイズしたフィールドのラベルは失われます。このため、カスタマイズしたフィールドや関連データがデータベース上に存在していても、フィールドは表示されなくなります。

 スタジオでレイアウトを変更した場合は、変更情報が失われ、再設定する必要があります。モジュールビルダーから再配置する前にスタジオでカスタムフィールドを作成し、レイアウトに追加していた場合、モジュールビルダーでそれらをレイアウトに再度追加する必要があります。

 スタジオでカスタマイズした関連情報が失われます。関連情報のテーブルと、それに格納されていたレコード間の関連はデータベースから削除されます。

   エクスポート:これは開発者向けにパッケージを配布するためのオプションです。Sugarはパッケージのzipファイルを作成するので、それをローカル環境に保存し、他の開発者へEメールなどで配布します。受信した開発者はモジュールローダーを使用し、zipファイルを自身のSugar環境へインストールし、必要に応じてモジュールビルダーを使用し、さらにカスタマイズすることができます。パッケージはモジュールビルダーでのみ見ることができます。このため、パッケージが配置されるまで、システム管理者だけがパッケージにアクセスすることができます。


2. パッケージの作成

パッケージの作成手順は以下の通りです。

1. 管理画面の「開発者向けツール」サブパネルにある「モジュールビルダー」をクリックします。

2. モジュールビルダー画面が表示されるので、「新規パッケージ」をクリックします。

3. パッケージ画面が表示されるので、以下の情報を入力して「保存」をクリックします。

 パッケージ名(必須フィールド):パッケージの名称を入力します。空白を含まないアルファベットと英数字を使用できます。

 作成者:パッケージ作成者の名前を入力します。

 キー(必須フィールド):似た名前のモジュールと区別するために文字列を入力します。空白を含まないアルファベットと英数字を使用できます。Sugarでは全てのクラス名やディレクトリ、テーブル名の先頭にキーの文字列を付加します。

 詳細:パッケージについての説明を入力します。

4. 「保存」をクリックしてパッケージを作成します。

作成したパッケージについて、モジュールビルダーでパッケージを選択して以下のような操作を行うことができます。

 削除:パッケージを削除するには、「削除」をクリックします。

 複製:パッケージの内容を複製して新しいパッケージを作成するには、「複製」をクリックします。Sugarは元のパッケージ名の末尾に「1」を付加して、パッケージのコピーを作成します。2つ目以降は末尾に付加する文字が2,3,4…となります。

 公開:パッケージを、作成したSugar環境とは別の環境にインストールするには、「公開」をクリックします。パッケージのzipファイルが作成されます。

 配置:パッケージを、作成したSugar環境で使用するには、「配置」をクリックします。

 エクスポート:開発者向けにパッケージをエクスポートするには「エクスポート」をクリックします。

 

パッケージ内にモジュールを作成する手順は以下の通りです。

1. パッケージ画面で「新規モジュール」アイコンをクリックします。

2. 新規モジュール画面が表示されるので、以下のフィールドに情報を入力します。

 モジュール名:モジュールの名前を入力します。

 ラベル:モジュールにつけるラベル名を入力します。ユーザがモジュールを操作する際にはラベル名が表示されます。

 インポート可能:このモジュールでデータのインポートを有効にするには、このチェックボックスにチェックします。

 チームセキュリティ:デフォルトでは、このオプションはモジュール内で作成されるレコードをアクセス、管理するためにチームに割り当てられるのを有効にします。必要な場合、チームセキュリティを無効にするには、このチェックボックスのチェックを外します。

 ナビゲーションタブ:デフォルトでは、他のSugarタブと同じモジュールタブを作成することができます。

 タイプ:作成するモジュールに対してテンプレートのタイプを選択するためにクリックします。

3. 「保存」をクリックすることで、モジュールが保存され、パッケージに追加されます。

このシステムでは、選択されたテンプレートを表示するためにページを更新します。新しいモジュールはモジュールビルダーのホーム画面にあるパッケージパネルに表示されているパッケージに組み込まれます。

左側にあるパッケージパネルはパッケージ内に作成する全てのモジュールを表示します。選択されたテンプレートからデフォルトのフィールド、ラベル、レイアウト、サブパネル、関連はモジュール内に組み込まれます。詳細を表示するにはそれらをクリックします。また他のSugarモジュールでは、デフォルトのレイアウトや新しいフィールドを編集し、関連を作成します。

レイアウトや検索フォームをカスタマイズするための詳細については、「スタジオ」にある「モジュールレイアウトの編集」を参照してください。新しいフィールドの作成についての詳細は、「フィールドを追加するには」を参照してください。定義関係についての詳細は、「スタジオ」にある「関連の作成」を参照してください。

 

Sugarダッシュレットを編集するには

1. カスタムモジュール画面上で、「レイアウトの表示」をクリックします。あるいは、左側にあるパッケージパネルの「レイアウト」をクリックします。

2. 「ダッシュレット」をクリックします。

Sugarダッシュレットの一覧ビューや検索フォームを編集できます。

3. ダッシュレットの一覧ビューを編集するには、「ダッシュレット一覧ビュー」をクリックします。これ以降の手順については、「スタジオ」にある「一覧ビューを編集するには」を参照してください。

また、ダッシュレットの検索フォームを編集するには、「ダッシュレット検索」をクリックします。これ以降の手順については、「スタジオ」にある「検索フォームを編集するには」を参照してください。

 

パッケージの配置やインストールを行うには

1. モジュールビルダーにおいて、パッケージを選択して「公開」、「配置」、または「エクスポート」をクリックします。

「公開」または「エクスポート」を選択する場合、システムはあなたのローカルマシンでエクスポートし、必要ならば、配置できるzipファイルとして保存します。「配置」を選択する場合、システムはSugarインスタンスにあるパッケージでカスタムモジュールをインストールします。

2. 「公開」または「エクスポート」を選択する場合、「ファイルを保存する」ラジオボタンを選択し、「OK」をクリックします。

モジュールローダーはSugarのマシンからファイルを更新し、またモジュールをインストールするために使用します。詳細については、「開発者向けツール()」にある「モジュールローダー」を参照してください。


3. パッケージの削除

必要な場合、パッケージを削除できます。パッケージを削除する場合、パッケージが含まれる全てのファイルが削除されます。配置後にパッケージを削除する場合、モジュールローダーを使用し配置されたパッケージはアンインストールされます。パッケージがアンインストールされた場合、データベーステーブルを残すか、あるいは取り除くオプションがあります。

新しいバージョンがインストールされる前にパッケージを削除する必要がありません。新しいバージョンのファイルはそれより前のパッケージである既存のファイルを上書きします。つまり、再配置する前のパッケージを更新させるには前のバージョンからファイルを上書きします。

Comments