みなさま、こんにちは!
アラスジャパン トレーナーの時田です。
「Aras Innovator のトリセツ」 の最終回となる第24回のテーマは、 「メソッドの作成方法と呼び出し方」 です。
今回は、プログラムを利用して 「こんなことができます」 という簡単なカスタマイズ事例をご紹介してまいります。
なお、 第7回のブログ にて、「メソッド」に関する基本的な説明がされていますので、ぜひそちらからご覧ください。
◆メソッドの作成方法◆
まず、メソッドの作成方法からご紹介していきます。
Aras Innovator にログインしたら、 TOC > アドミニストレータ > メソッド を開き、メソッドアイテムを新規作成します。
すると、以下のメソッドエディタが表示されます。
① 名称・・・メソッドの名称を入力します(必須)。大文字と小文字が区別されます。
② コメント・・・メソッドの目的や説明をなど入力します。
③ 実行許可・・・このメソッドの実行を許可するアイデンティティを指定します。
④ ツールバー・・・詳細は以下でご紹介します。
⑤ Code Guide・・・IOMの簡易ガイドです。当ブログの最後に紹介している 「API Reference」 では、より詳細に説明されています。
⑥ Help / Debug・・・「Help」タブにはCode Guideで選択したクラス等のヘルプが表示され、「Debug」タブにはコンパイルエラーが表示されます。
ツールバーの詳細は、以下のとおりです。
「文法チェック」ボタンを押すと、コンパイルチェックにより文法エラーを確認することができます。
◆メソッドを利用して、カスタマイズしてみよう◆
では、実際にメソッドを利用してカスタマイズする例を3つ、ご紹介していきます。
① 文書番号を自動採番する
一つ目は、「文書タイプに応じて、採番ルールを自動的に切り替えて文書番号を採番する」 という例です。
1. まず、以下のようなメソッドアイテムを作成します。
2. つづいて、アイテムタイプの「サーバーイベント」タブに作成したメソッドを登録します。今回のケースでは、イベントは「onBeforeAdd」です。
3. 最後に動作確認し、メソッドで指定した通りに採番されることを確認します。
② ステータスに応じて検索グリッドを色付けする
二つ目は、「ドキュメントアイテムのステータスに応じて、検索グリッド上に色を付ける」 という例です。
1. まず、以下のようなメソッドアイテムを作成します。
2. つづいて、アイテムタイプの「サーバーイベント」タブに作成したメソッドを登録します。今回のケースでは、イベントは「onAfterGet」です。
3. 最後に動作確認し、メソッドで指定した通りに検索グリッドが色付けされることを確認します。
③ 入力チェックを行う
最後は、「 owned_by_id(「設計責任者」欄)にアイデンティティ “ World ” が入力されていたらエラーを出す」 という例です。
1. まず、以下のようなメソッドアイテムを作成します。
2. つづいて、アイテムタイプの「サーバーイベント」タブに作成したメソッドを登録します。今回のケースでは、イベントは「onBeforeAdd」および「onBeforeUpdate」です。
3. 最後に動作確認し、メソッドで指定した通りにエラーメッセージが表示されることを確認します。
このように作成したメソッドアイテムをアイテムタイプに関連付けることで、様々なカスタマイズが簡単に行えます。
今回は、メソッドの書き方例や設定方法を簡潔にご紹介させていただきましたが、さらなる詳細を知りたい方は、ぜひ 月例トレーニング(APIコース) にご参加いただくか、 Programmer's Guide または Aras Innovator のユーザメニューからアクセス可能な 「API Reference」 をご参照ください。
では、また来月、こちらでお会いしましょう★
アラスジャパン トレーナー 時田 和佳奈