事前定義された JavaScript 関数

CA Service Catalog では、フォーム上でフィールドの自動タスクを実行するためのいくつかのオプションを提供しています。これには、レポート データ オブジェクト、JavaScript 式、JavaScript 関数が含まれます。 このトピックでは、事前定義済み JavaScript 関数をリストし、任意にそれらを使用して、フィールドのタスクを自動化する方法について概要を示します。

事前定義された JavaScript 関数の一部で使用されるオペランドの値を指定する際は、以下のガイドラインに従います。 ほとんどの関数では、以下に示すオペランドのうち最初の 2 つは必須で、その他はオプションです。 各関数の構文を確認し、その関数に適用されるオペランドを参照してください。

• formId には、関数を実行する対象のフォームの _id 属性の値を指定します。
• _id には、関数を実行するフォーム内の要素の _id 属性の値を指定します。
• name、value、index には、関数を実行する対象の要素のこれらの属性値を指定します。
• 特定の関数では、必要に応じて、その他のオペランドが使用されます。 たとえば、index 属性は、選択グループなど、特定の要素にのみ適用できます。

_.serviceoption.status( )

現在のフォームの行アイテムのステータスを返します。 この関数を使用すると、行アイテムのステータスに従って動的にフォームの属性を指定できます。 たとえば、特定のフォーム フィールドを、その行ステータスが完了すると非表示にする場合、その hidden 属性を「_.serviceoption.status() == 200」に設定します。

注： また、サービス オプション要素を非表示または無効にする場合にもこの関数を使用できます。 そのためには、非表示または無効のテキスト ボックスにこの機能を使用します。

この関数は、「保留」および「再開」ステータスに特に有効です。 テキスト メッセージにその理由を提供できます。

注： この関数はパラメータをとりません。

ca_fdDoFieldLookup(fieldId, reportId)

レポート データ オブジェクトを実行し、それをルックアップ フィールドに関連付けて、返されたデータをフォーム上の一致するフィールドにコピーします。 これらのアクションを使用して、レポート データ オブジェクトへのユーザ入力に基づいたフィールドへの入力を行うことができます。

fieldId に、ルックアップ フィールドの _id 属性の値を指定します。

reportId には、作成済みのデータ オブジェクトの値を指定します。

ca_reportQuery(reportId, variables, onSuccess, onFailure)

レポート データ オブジェクト（データ オブジェクト）を実行し、指定したデータをデータ ソース（MDB など）に照会して結果を返します。

• reportId には、照会するデータ オブジェクトを指定します。
• variables に、変数名と値の JavaScript マップを指定します。 たとえば、{“var1”:”foo”,”var2”:”bar”,”var3”:_.user.id} などです。 これらの変数は、レポート データ オブジェクトで照会するものと一致します。
• onSuccess には、クエリが正常に戻る場合に実行される JavaScript 関数を指定します。 onSuccess 関数は 1 つのオペランドをとる必要があります。 このオペランドには、クエリによって返された一連のマップ（それぞれが 1 行を表す）が設定されます。
• onFailure には、呼び出しが失敗した場合に実行される JavaScript 関数を指定します。

レポート データ オブジェクトと JavaScript 関数に基づいてフィールドに事前入力できます。

ca_fdValidateCC(credit card number, credit card type)

作成されたフォームにユーザが入力したクレジットカード番号の形式を検証します。

ca_fdShowField(formId, _id)

1 つのフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_id）を検索します。 また、まだ表示されていない場合は、そのフィールドを表示された状態にします。

ca_fdShowFields(formId, _ids)

複数のフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_ids）を検索します。 また、まだ表示されていない場合は、それらのフィールドを表示された状態にします。

ca_fdHideFields(formId, _ids) の例に示すように、2 番目のパラメータは、フォーム上の複数のフィールドの _ids が含まれる配列です。

ca_fdHideField(formId, _id)

1 つのフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_id）を検索します。 また、まだ非表示になっていない場合は、そのフィールドを非表示にします。

ca_fdHideFields(formId, _ids)

複数のフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_ids）を検索します。 また、まだ非表示になっていない場合は、それらのフィールドを非表示にします。

2 番目のパラメータは、フォーム上の複数のフィールドの _ids が含まれる配列です。 たとえば、フォーム上の最初の名前フィールドと最後の名前フィールドをいずれも非表示にすることを想定します。 また、フォームの _id は name_form、フィールドの _id 値は first_name と last_name です。 この場合は、以下のコードを使用します。

ca_fdHideFields("name_form", ["first_name","last_name"]

ca_fdDisableField(formId, _id)

1 つのフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_id）を検索します。 また、まだ無効になっていない場合は、そのフィールドを無効にします。

ca_fdDisableFields(formId, _ids)

複数のフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_ids）を検索します。 また、まだ無効になっていない場合は、それらのフィールドを無効にします。

ca_fdHideFields(formId, _ids) の例に示すように、2 番目のパラメータは、フォーム上の複数のフィールドの _ids が含まれる配列です。

ca_fdEnableField(formId, _id)

1 つのフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_id）を検索します。 また、まだ有効になっていない場合は、そのフィールドを有効にします。

ca_fdEnableFields(formId, _ids)

複数のフィールドに適用されます。

指定されたフォーム（formId）およびフィールド（_ids）を検索します。 また、まだ有効になっていない場合は、それらのフィールドを有効にします。

ca_fdHideFields(formId, _ids) の例に示すように、2 番目のパラメータは、フォーム上の複数のフィールドの _ids が含まれる配列です。

ca_fdSelectOption(formId, _id, name, value) および ca_fdSelectOptionByIndex(formId, _id, index)

これらのいずれかの関数を使用して、選択ボックス内の値をプログラム的に選択できます。 これらの関数には同じ効果があり、呼び出しの方法のみが異なります。

• ca_fdSelectOption は、選択フィールド内に指定された _id 属性、名前および値があるオプションを選択します。
• ca_fdSelectOptionByIndex は、選択フィールド内に指定された _id 属性およびインデックス値があるオプションを選択します。

  たとえば、以下の例を考えてみます。

  例 1

  この例では、選択ボックス内の最初のオプションを選択します。 この例では以下の値を使用します。

• フォームの _id 属性： form_id
• 選択ボックスの _id 属性： memory_select

  ca_fdSelectOption(‘form_id’, ‘memory_select’, 1)：
  

  例 2

  この例では、現在のフォームの選択ボックス内の最初のオプションを選択します。 この例では以下の値を使用します。

• フォームの _id 属性： ca_fd.formId
• 選択ボックスの _id 属性： memory_select

  ca_fdSelectOption(ca_fd.formId, ‘memory_select’, 1) :
  

  指定された選択ボックスが見つからないと、コールは無視されて、エラーはレポートされません。

  例 3

  オプションの明示的な値を指定して、前の例を以下のように書き直すことができます。

  ca_fdSelectOption(‘form_id’, ‘memory_select’, ‘option1’, ‘option1_value’), ca_fdSelectOption(ca_fd.formId, ‘memory_select’, ‘option1’, ‘option1_value’):
  

option1

フォーム デザイナ ツリーに表示されるときと同じオプションの名前を指定します。 このオプションの値は option1_value です。

ca_fdUnselectOption(formId, _id, name, value)

対応する _id 属性とともに、選択フィールド内に指定された名前と値があるオプションを選択解除します。

ca_fdUnselectOptionByIndex(formId, _id, index)

対応する _id 属性とともに、選択フィールド内に対応するインデックスがあるオプションを選択解除します。

ca_fdUnselectAllOptions(formId, _id)

対応する _id 属性がある選択フィールド内のすべてのオプションを選択解除します。

ca_fdGetSelectedOptions(formId, _id)

選択されたオプションのインデックスを示す整数の配列を返します。

ca_fdGetSelectedOptionValues(formId, _id)

選択されたオプションの値を示す文字列の配列を返します。 最初のオプション値を以下のように選択します。

ca_fdGetSelectedOptionValues(formId, _id)[0]

0 の値を 1 に変更して 2 番目のオプション値を選択し、同様に、1 を 2 に変更して 3 番目のオプションを選択します。

この関数は、特に、ユーザ入力を使用して選択ボックスに事前入力するために役立ちます。

ca_fdSelectRadio(formId, name, _id)

対応する name 属性のラジオ グループで、対応する _id を持つラジオ ボタンを選択します。

ca_fdIsSelectRadio (formId, name, _id)

指定されたラジオ ボタンが選択されたかどうかを返します。

ca_fdSelectCheckBox(formId,_id)

対応する _id 属性を持つチェック ボックスを選択します。

ca_fdUnselectCheckBox(formId, _id)

対応する _id 属性を持つチェック ボックスをオフにします。

ca_fdIsSelectedCheckBox(formId,_id)

指定されたチェック ボックスが選択されたかどうかを返します。

ca_fdSetDateFieldValue(formId, _id, date) と関連関数

対応する _id 属性の指定された日付フィールドの値を設定します。 この関数は、date という名前のパラメータに Null 値、文字列値、長整数型値をとることができます。

フィールドの値をクリアするには、空の文字列および NULL を使用します。

日付時刻フィールド（フォームの要素）用に指定された形式で、空ではない文字列を以下のように指定します。

• 日付時刻フィールドの時刻部分が非表示の場合は、日付形式のみで文字列を指定します。 日付時刻フィールドの形式属性またはビジネス ユニットの日付形式を使用します。
• 日付時刻フィールドの時間部分が表示される場合、そのフィールドによって指定された形式で文字列を指定します。

  どちらの場合も、複数の文字列はスペースで区切ります。

  日付を設定するための関連する JavaScript 関数は以下のとおりです。 ca_fdSetDateFieldValue(formId, _id, date) 関数の前述の説明がこれらの関数にも当てはまります。

• ca_fdSetDateFieldMinValue(formId, _id, date) – 日付の最小値を設定します。
• ca_fdSetDateFieldMaxValue(formId, _id, date) – 日付の最大値を設定します。

  また、すべての ca_fdSetDateField* JavaScript 関数では、「エポック」以後のミリ秒数で日付を設定できます。エポックは、深夜を表す GMT の標準基準時刻（1970 年 1 月 1 日 0 時 0 分 0 秒）です。 このような日付の設定の詳細については、Oracle の Web サイト、oracle.com などで、標準の Java プログラミング リファレンスを参照してください。

ca_fdGetDateFieldValue(formId, _id, date) と関連関数

指定された日付フィールドの日付の値を、日付フィールドに指定された形式にフォーマットされた文字列として取得します。

前述の関数（ca_fdSetDateFieldValue(formId, _id, date)）の説明がこの関数にも当てはまります。

日付を取得するための関連する JavaScript 関数は以下のとおりです。 ca_fdGetDateFieldValue(formId, _id, date) 関数の前述の説明がこれらの関数にも当てはまります。

• ca_fdGetDateFieldValueInMillis(formId, _id, date) – 日付の値をミリ秒数で取得します。
• ca_fdGetDateFieldMinValue(formId, _id, date) – 日付の最小値を取得します。
• ca_fdGetDateFieldMinValueInMillis(formId, _id, date) – 日付の最小値をミリ秒数で取得します。
• ca_fdGetDateFieldMaxValue(formId, _id, date) – 日付の最大値を取得します。
• ca_fdGetDateFieldMaxValueInMillis(formId, _id, date) – 日付の最大値をミリ秒数で取得します。

  また、すべての ca_fdGetDateField* JavaScript 関数では、「エポック」以後のミリ秒数で日付を取得できます。エポックは、深夜を表す GMT の標準基準時刻（1970 年 1 月 1 日 0 時 0 分 0 秒）です。 このような日付の取得の詳細については、Oracle の Web サイト、oracle.com などで、標準の Java プログラミング リファレンスを参照してください。

ca_fdSetTextFieldValue(formId, _id, text)

対応する _id 属性を持つテキスト フィールドのテキストを設定します（テキスト フィールドとテキスト領域が可）。

ca_fdGetTextFieldValue(formId, _id)

対応する _id 属性を持つテキスト フィールドのテキストを取得します（テキスト フィールドとテキスト領域が可）。

ca_fdFetchSelectData(formId,_id)

指定された _id を持つ選択ボックスで、レポート データ オブジェクトを再度取得するようにします。 この関数は、レポート データ オブジェクトにユーザ入力が反映される場合に特に有用です。 ベスト プラクティスとして、ユーザ入力が変更された場合は、選択ボックスに常に正しい値が表示されるよう、この関数を呼び出すことを強くお勧めします。

また、この関数は、特に、ユーザ入力を使用して選択ボックスに事前入力するために役立ちます。

以下の関数は、システム フォームでのみ使用できます。

• custom_onPriorityChange(newPriority)
• custom_onDateRequiredChange(newDateRequired)
• custom_onRequestedForChange(type, id, name, shippingAddress)