有用なサービスおよびビジネス・サービス

次の項では、製品に用意されている、使用する実装に役立つビジネス・サービスおよびサービスについて説明します。

データ・エクスプローラ・サービス

システムには、スクリプト、Javaプラグイン、またはWebサービス・コールを介して使用するSQL select文を実行するメカニズムが用意されています。これを実行するには、SQLが定義されている場所でいずれかのデータ・エクスプローラ・ゾーン・タイプを使用してゾーンを作成します。次に、データ・エクスプローラ・サービス(FWLZDEXP)を使用してビジネス・サービスを作成します。

注意: 基本製品には、このサービスを参照する多数のビジネス・サービスが用意されており、テンプレートとして使用できます。

次に、このサービスに対して独自のビジネス・サービスを作成する方法を説明します。通常、ゾーンごとに個別のビジネス・サービスが存在することに注意してください。

  • ビジネス・サービス・コードおよび摘要を入力します。どのビジネス・サービスがどのゾーンを起動するかを簡単に管理できるように、ゾーン・コードと一致するビジネス・サービス・コードを定義することをお薦めします。
  • 「サービス名」に「FWLZDEXP」を選択します。
  • 「スキーマ」タブの<schema>ノードの下で、データ・エクスプローラ・サービスに必要なフィールドのマッピングを入力します。
    • ゾーンをサービス・フィールドのZONE_​CD にマップします。ソーン・コードをデフォルト値として定義します。
    • ゾーンに定義された各ユーザー・フィルタについて、サービス・フィールドFx_​VALUEへのスキーマ・マッピングを作成します。"x"はフィルタ番号(ゾーン・パラメータからの)です。
    • ゾーンに定義された各非表示フィルタについて、サービス・フィールドHx_​VALUEへのマッピングを作成します。"x"はフィルタ番号(ゾーン・パラメータからの)です。
    • データ・エクスプローラ・サービスによって検索結果がリストとして返されます。各列値はサービス・フィールドCOL_​VALUEにあり、適切なシーケンス番号(SEQNO)が付いています。論理要素名を定義できるシーケンス番号に基づいて結果をフラット化できます。
    • 別の有用なフィールドはROW_​CNTで、検索で取得された行数を表示します。

次に、ビジネス・オブジェクト・コードを受け取ってステータス値とその摘要(ステータス事由を定義できる)のリストを返すビジネス・サービスのスキーマの例を示します。


<schema>
     <zone mapField="ZONE_CD" default="F1-BOSTSLST"/>
     <bo mapField="H1_VALUE" />>
     <rowCount mapField="ROW_CNT"/>>
     <results type="list" mapList="DE">>
          <status dataType="string" mapField="COL_VALUE">
               <row mapList="DE_VAL">>
                    <SEQNO is="1" />>
               </row>>
          </status>>
          <description dataType="string" mapField="COL_VALUE">
               <row mapList="DE_VAL">>
                    <SEQNO is="2" />>
               </row>>
          </description>>
      </results>>
</schema>

メンテナンス・オブジェクトのログ・サービス

多くのメンテナンス・オブジェクトでは、列名と動作のパターンを追跡するログ表をサポートしています。システムには、ログ・エントリに関連する一般的な関数の実行に使用できる「汎用MOログ・サービス」(F1MOLOGP)というサービスが用意されています。

  • ログ・エントリの読取り。特定のメンテナンス・オブジェクト、主キーおよびログ・シーケンス番号を渡すと、サービスからそのログ・エントリの詳細が返されます。製品には、この目的のために使用できる汎用ビジネス・サービス「汎用MO - ログ詳細の取得」(F1–ReadMOLog)が用意されています。あるいは、デフォルト構文を使用してメンテナンス・オブジェクト・コードがメンテナンス・オブジェクト要素に割り当てられる、特定のメンテナンス・オブジェクトのビジネス・サービスを作成できます。これによって、そのメンテナンス・オブジェクトに固有のビジネス機能が特定のビジネス・サービスを使用できます。

  • ログの追加。このサービスは、ログ・エントリを追加するために使用できます。ユーザー・ログが追加されると、そのユーザーからのコメントが詳細摘要に移入されます。通常、システムで生成されたログ・エントリでは、メッセージ・カテゴリ/メッセージ番号が、ステータス、特定のログ・タイプ、およびオプションで関連オブジェクト参照(特性を使用)などのその他の情報とともに提供されます。製品には、この目的のために使用できる汎用ビジネス・サービス「汎用メンテナンスオブジェクト・ログの追加」(F1–AddMOLog)が用意されています。あるいは、デフォルト構文を使用してメンテナンス・オブジェクト・コードがメンテナンス・オブジェクト要素に割り当てられる、特定のメンテナンス・オブジェクトのビジネス・サービスを作成できます。これによって、そのメンテナンス・オブジェクトに固有のビジネス機能が特定のビジネス・サービスを使用できます。

基本のビジネス・サービス

次の表では、製品に用意されている、実装のカスタム・ロジックに役立つビジネス・サービスについて説明します。

注意: これは、ビジネス・サービスの完全な参照を意図していません。サポートされているすべてのビジネス・サービスを確認するには、ビジネス・サービスのページを参照してください。

ビジネス・オブジェクト関連サービス

ビジネス・サービス名 摘要
F1-AutoTransitionBO 特定のビジネス・オブジェクト・インスタンスの現在の状態(後続の状態に遷移する可能性がある)に関連付けられたモニタリング・アルゴリズムを実行します。
F1-CompareBusinessObjectData 特定のビジネス・オブジェクト・インスタンスの2つのバージョンを比較します。
F1-DetermineBo メンテナンス・オブジェクトの「ビジネス・オブジェクトの決定」ロジックを実行して、メンテナンス・オブジェクトの特定インスタンスのビジネス・オブジェクトを決定します。
F1-GetRequiredFieldsForBOState 特定のビジネス・オブジェクト・ステータスに必要なフィールドを返します。
F1-RetrieveBOOption 特定のビジネス・オブジェクトとオプション・タイプのビジネス・オブジェクト・オプション値を返します。
F1-RetrieveBOStatusOption 特定のビジネス・オブジェクト、ステータスおよびオプション・タイプのビジネス・オブジェクト・オプション値を返します。
F1-RetrieveBOStatusOption 現行ユーザーがアクセスできる特定のメンテナンス・オブジェクトのビジネス・オブジェクト・リストを取得します。
F1-RetrieveBoStatusDescription 特定のビジネス・オブジェクト・ステータスの摘要を返します。
F1-RetrieveBusinessObjectLabel ビジネス・オブジェクト・スキーマ内の特定のパス(例: 要素)に適切なラベルを返します。
F1-RetrieveNextStates メンテナンス・オブジェクトとその主キー、またはビジネス・オブジェクトとそのいずれかのステータスの入力に基づいて、次に可能な状態のリストを返します。

Eメール関連サービス

ビジネス・サービス名 摘要
F1-EmailService Eメール・メッセージをリアル・タイムで送信します。
F1-RetrieveEmailAddress 作業予定役割に属するユーザーのEメール・アドレスを取得します。
F1-RetrieveEnvironmentURL インストールの現在の環境URL情報を取得します。

マップおよびスクリプト用のツール

ビジネス・サービス名 摘要
F1-AddWarning このビジネス・サービスは、メッセージの詳細を指定して警告をログに記録するために使用できます。システムによって警告がすべて収集され、ユーザーに一度に表示されます。
F1-CheckOnlineConnection 接続がオンラインかバッチかをチェックします。
F1-CheckWarning 警告が累積されているかどうかをチェックするために使用されます。警告が累積されている場合、(警告が表示された時点に)ロールバックできないロジックは実行しないでください。
F1-DateMath 様々な日時の算術計算を実行します。詳細は、ビジネス・サービスの説明を参照してください。
F1-DateTimeFormattingService ユーザーの表示プロファイル設定に基づいて特定の日時を書式設定します。
F1-ExecuteScriptInNewSession 新しい処理セッション/トランザクションでサービス・スクリプトを実行します。
F1-GetFieldLabel 特定のフィールドのラベルを取得します。
F1-GetForeignKeyReference 特定の外部キー参照および主キーの外部キー参照情報(情報の摘要、ナビゲーション・オプションおよびコンテキスト・メニューを含む)を返します。
F1-GetFKReferenceDetails 特定のメンテナンス・オブジェクトおよび主キーの外部キー参照情報(外部キー参照コード、情報の摘要、ナビゲーション・オプション、検索ゾーンおよびコンテキスト・メニューを含む)を返します。
F1-GetLookupDescription 特定の参照フィールド名の参照フィールド値の参照摘要を返します。
F1-GetExtLookUpVal 特定の拡張可能参照ビジネス・オブジェクトの値リストを返します。
F1-GetMonthInYearAbbreviation システム書式の入力日に対する3文字の月略称を返します。
F1-NumberAmountFormatter ユーザーの表示プロファイル設定に基づいて特定の金額または数値を書式設定します。また、入力を受け取ってスケールを調整し、オプションで通貨設定を適用することもできます。
F1-OutmsgDispatcher リアルタイム・メッセージを割り当てる際に、メッセージをデータベースで永続化するか、コール中に発生する可能性があるエラーをトラップするかどうかのオプションをユーザーに提供します。詳細は、「リアル・タイム・メッセージ」を参照してください。
F1-OutmsgMediator F1-OutmsgDispatcherにかわるオプションで、送信者がアウトバウンド・メッセージ・レコードのインスタンス化を必要としない場合は、より適切なオプションです。詳細は、「リアル・タイム・メッセージ」を参照してください。
F1-RethrowError 入力メッセージ・カテゴリ/番号/パラメータを使用してアプリケーション・エラーを発行します。
F1-RetrieveMODescription メンテナンス・オブジェクトの摘要を取得します。
F1-ReturnMessage 特定のメッセージ・カテゴリ、番号、パラメータおよびパラメータ・タイプの拡張メッセージを返します。
F1-SavePointDispatcher 例外がトラップされ、サービス・スクリプト実行前に設定されたセーブ・ポイントまでトランザクションがロールバックされた場合に、サービス・スクリプトの実行を可能にします。

ユーザー関連サービス

ビジネス・サービス名 コメント
F1-CheckApplicationSecurity 特定のアプリケーション・サービス/アクセス・モードへのユーザーのセキュリティ・アクセス権をチェックします
F1-CheckUserAuthorization 入力アプリケーション・サービス、セキュリティ・コードおよび認証レベルに基づいて、特定のユーザーにアクセス権があるかどうかを判定します。
F1-DetermineIfUserCanApproveTD 現行ユーザーが特定の作業予定を承認できるかどうかを判定します。