openForm (การอ้างอิง JavaScript API) สําหรับ Dynamics 365 Channel Integration Framework 1.0

เปิดฟอร์มเอนทิตีหรือฟอร์มสร้างด่วน

Syntax

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

Parameters

ชื่อ	ประเภท	ต้องมี	คำอธิบาย
entityFormOptions	วัตถุ JSON	ใช่	ตัวเลือกฟอร์มเอนทิตีสําหรับการเปิดฟอร์ม อ็อบเจ็กต์ประกอบด้วยแอตทริบิวต์ต่อไปนี้: - cmdbar - สร้างจากเอนทิตี - entityId - ชื่อเอนทิตี - ฟอร์มไอดี -ความสูง - navBar - เปิดในหน้าต่างใหม่ - window ตําแหน่ง - รหัส processId - รหัส processInstanceId -ความสัมพันธ์ - selectStageId - ใช้ QuickCreateForm -ความกว้าง ดูตารางentityFormOptionsอ็อบเจ็กต์สําหรับข้อมูลเกี่ยวกับแอตทริบิวต์
formParameters	วัตถุ	ไม่	วัตถุพจนานุกรมที่ส่งผ่านพารามิเตอร์พิเศษไปยังฟอร์ม พารามิเตอร์ที่ไม่ถูกต้องจะทําให้เกิดข้อผิดพลาด สําหรับข้อมูลเกี่ยวกับการส่งพารามิเตอร์ไปยังฟอร์ม โปรดดู ตั้งค่าฟิลด์โดยใช้พารามิเตอร์ที่ส่งผ่านไปยังฟอร์ม และ กําหนดค่าฟอร์มเพื่อยอมรับพารามิเตอร์สตริงคิวรีแบบกําหนดเอง
successCallback	Function	ไม่	ฟังก์ชันที่จะดําเนินการเมื่อการดําเนินการสําเร็จ
errorCallback	Function	ไม่	ฟังก์ชันที่จะดําเนินการเมื่อการดําเนินการล้มเหลว

entityFormOptions แอตทริบิวต์วัตถุ

ตารางต่อไปนี้อธิบายแอตทริบิวต์ของ entityFormOptions พารามิเตอร์

Note

แอตทริบิวต์เป็นทางเลือก

ชื่อแอตทริบิวต์	ประเภท	คำอธิบาย
cmd บาร์	แบบบูลีน	ระบุว่าจะแสดงแถบคําสั่งหรือไม่ ถ้าคุณไม่ได้ระบุพารามิเตอร์นี้ แถบคําสั่งจะแสดงตามค่าเริ่มต้น
สร้างจากเอนทิตี	การค้นหา	ระบุเรกคอร์ดที่จะให้ค่าเริ่มต้นตามค่าแอตทริบิวต์ที่แมป ออบเจ็กต์การค้นหามีคุณสมบัติต่อไปนี้ของชนิด String: entityType, และ idname (ไม่บังคับ)
entityId	สตริง	ตัวระบุของเรกคอร์ดเอนทิตีเพื่อแสดงฟอร์ม
ชื่อเอนทิตี	สตริง	ชื่อตรรกะของเอนทิตีที่จะแสดงฟอร์ม
formId	สตริง	ตัวระบุของอินสแตนซ์ฟอร์มที่จะแสดง
ความสูง	หมายเลข	ความสูงของหน้าต่างฟอร์มที่จะแสดงเป็นพิกเซล
navBar	สตริง	ควบคุมว่าแถบนําทางจะแสดงหรือไม่ และการนําทางโปรแกรมประยุกต์จะพร้อมใช้งานโดยใช้พื้นที่และพื้นที่ย่อยที่กําหนดไว้ในแผนผังเว็บไซต์หรือไม่ ค่าที่ถูกต้องคือ: on: แถบนําทางจะปรากฏขึ้น นี่คือลักษณะการทํางานเริ่มต้นหาก navBar ไม่ได้ใช้พารามิเตอร์ off: แถบนําทางไม่แสดงขึ้น ผู้ใช้สามารถนําทางโดยใช้องค์ประกอบส่วนต่อประสานผู้ใช้อื่นๆ หรือปุ่มย้อนกลับและไปข้างหน้า entity: บนฟอร์มเอนทิตี เฉพาะตัวเลือกการนําทางสําหรับเอนทิตีที่เกี่ยวข้องเท่านั้นที่พร้อมใช้งาน หลังจากนําทางไปยังเอนทิตีที่เกี่ยวข้อง ปุ่มย้อนกลับจะแสดงบนแถบนําทางเพื่อให้สามารถกลับไปยังเรกคอร์ดเดิมได้
เปิดใหม่หน้าต่าง	แบบบูลีน	ระบุว่าจะแสดงฟอร์มในหน้าต่างใหม่หรือไม่
window ตําแหน่ง	หมายเลข	ระบุตําแหน่งของฟอร์มบนหน้าต่าง ค่าที่ถูกต้องคือ: 1 สําหรับตําแหน่งกึ่งกลางและ 2 สําหรับตําแหน่งด้านข้าง
รหัส processId	สตริง	ตัวระบุของกระบวนการทางธุรกิจที่จะแสดงบนฟอร์ม
รหัส processInstanceId	สตริง	ตัวระบุของอินสแตนซ์กระบวนการธุรกิจที่จะแสดงบนฟอร์ม
ความสัมพันธ์	วัตถุ JSON	ระบุวัตถุความสัมพันธ์เพื่อแสดงเรกคอร์ดที่เกี่ยวข้องบนฟอร์ม ดูตารางrelationshipอ็อบเจ็กต์สําหรับข้อมูลเกี่ยวกับแอตทริบิวต์
selectStageId	สตริง	ตัวระบุของขั้นตอนที่เลือกในอินสแตนซ์กระบวนการทางธุรกิจ
ใช้ QuickCreateForm	หมายเลข	ความกว้างของหน้าต่างฟอร์มที่จะแสดงเป็นพิกเซล

relationship แอตทริบิวต์วัตถุ

ตารางต่อไปนี้อธิบายแอตทริบิวต์ของแอ็ตทริบิวต์ออ relationship บเจ็กต์ของ entityFormOptions พารามิเตอร์

Note

แอตทริบิวต์เป็นทางเลือก

ชื่อแอตทริบิวต์	ประเภท	คำอธิบาย
ชื่อแอตทริบิวต์	สตริง	ชื่อของแอตทริบิวต์ที่ใช้สําหรับความสัมพันธ์
ชื่อ	สตริง	ชื่อของความสัมพันธ์
navigation คุณสมบัติ	สตริง	ชื่อของคุณสมบัติการนําทางสําหรับความสัมพันธ์
ประเภทความสัมพันธ์	หมายเลข	ประเภทความสัมพันธ์ ค่าที่ถูกต้องคือ: 0 สําหรับความสัมพันธ์แบบหนึ่งต่อกลุ่มและ 1 สําหรับความสัมพันธ์แบบกลุ่มต่อกลุ่ม
ประเภทบทบาท	หมายเลข	ประเภทบทบาทในความสัมพันธ์ ค่าที่ถูกต้องคือ: 1 สําหรับการอ้างอิง และ 2 สําหรับ AssociationEntity

ส่งคืนค่า

เมื่อสําเร็จ จะส่งคืนวัตถุ Promise ที่มีสตริง

ตัวอย่าง

โค้ดตัวอย่างต่อไปนี้จะเปิดฟอร์มเหตุการณ์ใหม่ด้วยค่าที่เติมไว้ล่วงหน้าสําหรับบางฟิลด์ เช่น รหัสผู้ติดต่อและคําอธิบาย

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);
    }
  );