Dynamics 365 チャネル統合フレームワーク 1.0 の openForm (JavaScript API リファレンス)

エンティティ フォームまたは簡易作成フォームを開きます。

構文

Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);

Parameters

件名	タイプ	Required	Description
entityFormOptions	JSON オブジェクト	可	フォームを開くためのエンティティ フォーム オプション。 オブジェクトには、次の属性が含まれています。 - cmdbar - createFromEntity - entityId - entityName - formId - height - navBar - openInNewWindow - windowPosition - processId - processInstanceId - relationship - selectStageId - useQuickCreateForm - width 属性に関する情報については、entityFormOptionsオブジェクト テーブルを参照してください。
formParameters	Object	いいえ	追加のパラメーターをフォームに渡すディクショナリ オブジェクト。 パラメーターが無効の場合、エラーが発生します。 フォームにパラメーターを渡す方法の詳細については、フォームに渡すパラメーターを使用してフィールド値を設定する および カスタム クエリストリング パラメーターが許可されるフォームの構成 を参照してください。
successCallback	Function	いいえ	処理が成功したときに実行する関数。
errorCallback	Function	いいえ	処理が失敗したときに実行する関数。

entityFormOptions オブジェクト属性

次の表に、entityFormOptions パラメーターの属性を説明します。

注意

属性はオプションです。

Attribute name	タイプ	Description
cmdBar	ブール型	コマンド バーを表示するかどうかを指定します。 このパラメーターの値を指定しない場合、既定でコマンド バーが表示されます。
createFromEntity	参照	マップした属性値に基づいて既定値を提供するレコードを示します。 検索オブジェクトには、タイプ文字列 entityType、id、およびname (任意) のプロパティがあります。
entityId	String	フォームを表示するエンティティ レコードの識別子。
entityName	String	フォームを表示するエンティティの論理名。
formId	String	表示するフォーム インスタンスの識別子。
高さ	回数	表示するフォーム ウィンドウの高さ (ピクセル単位)。
navBar	String	サイトマップで定義されているエリアとサブエリアを使用して、ナビゲーション バーを表示するかどうか、およびアプリケーションのナビゲーションを使用可能にするかどうかを制御します。 有効な値は次の通りです。 on: ナビゲーション バーが表示されます。 navBarパラメーターが使用されていない場合の既定の動作です。 off: ナビゲーション バーは表示されません。 ユーザーは、他のユーザー インターフェイス要素、または戻るボタンと進むボタンを使用して移動できます。 entity: エンティティ フォームでは、関連するエンティティのナビゲーション オプションのみが利用可能です。 関連エンティティへの移動の後は、ナビゲーション バーに [戻る] ボタンが表示され、元のレコードに戻ることができます。
openInNewWindow	ブール型	新しいウィンドウでフォームを表示するかどうかを示します。
windowPosition	回数	ウィンドウ上のフォームの位置を示します。 有効な値は、中央位置の場合は 1、サイド位置の場合は 2 です。
processId	String	フォームに表示するビジネス プロセスの識別子。
processInstanceId	String	フォームに表示するビジネス プロセス インスタンスの識別子。
relationship	JSON オブジェクト	フォームに関連レコードを表示する関係オブジェクトを示します。 属性に関する情報については、relationshipオブジェクト テーブルを参照してください。
selectStageId	String	ビジネス プロセス インスタンスで選択したステージの識別子。
useQuickCreateForm	回数	表示するフォーム ウィンドウの幅 (ピクセル単位)。

relationship オブジェクト属性

次の表に、 entityFormOptions パラメーターの relationship オブジェクト属性の属性を説明します。

注意

属性はオプションです。

Attribute name	タイプ	Description
attributeName	String	関係で使用される属性の名前です。
名称	String	リレーションシップの名前です。
navigationProperty	String	リレーションシップのナビゲーション プロパティの名前。
relationshipType	回数	リレーションシップ タイプ。 有効な値は、1 対多の関係の場合は 0、多対多の関係の場合は 1 です。
roleType	回数	リレーションシップのロール タイプ。 有効な値は、referencing の場合は 1、AssociationEntity の場合は 2 です。

値を返す

成功すると、文字列を含む Promise オブジェクトを返します。

例

次のサンプル コードは、取引先担当者 ID や説明などの特定のフィールドの値が事前に入力された新しいインシデント フォームを開きます。

var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
var title = "Sample Case Form"
var entityFormOptions = {};
    entityFormOptions["entityName"] = "incident";
    
var formParameters = {};
    //pre-populate some fields based on the context
    formParameters["title"] = title;
    formParameters["customerid"] = id;
    formParameters["customeridtype"] = "contact";
    formParameters["caseorigincode"] = 1;
    formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";

//Open the form
Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
      function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    }
  );