ทำให้เครื่องมือเชื่อมต่อ Microsoft SharePoint Online ใช้งานได้

ข้อควรระวัง: ตัวเชื่อมต่ออ้างอิงของ Cloud Search มีให้ "ตามสภาพ" เป็นโค้ดตัวอย่างสำหรับใช้ในการสร้างตัวเชื่อมต่อที่ใช้งานได้ของคุณเอง โค้ดตัวอย่างนี้ต้องมีการปรับแต่งและทดสอบอย่างมากก่อนนำไปใช้ในสภาพแวดล้อมการพิสูจน์แนวคิดหรือการทำงานจริง สำหรับการใช้งานจริง เราขอแนะนำให้ขอรับความช่วยเหลือจากพาร์ทเนอร์ Cloud Search ของเรา หากต้องการความช่วยเหลือในการค้นหาพาร์ทเนอร์ โปรดติดต่อผู้จัดการฝ่ายดูแลลูกค้าของ Google

คุณตั้งค่า Google Cloud Search ให้แสดงผลลัพธ์จากเนื้อหา SharePoint Online ขององค์กรได้ นอกเหนือจากเนื้อหา Google Workspace ใช้ เครื่องมือเชื่อมต่อ SharePoint Online ของ Cloud Search และกำหนดค่าให้ เข้าถึงแหล่งข้อมูล SharePoint Online ที่เฉพาะเจาะจง

สิ่งสำคัญที่ต้องคำนึงถึง

ก่อนที่จะติดตั้งใช้งานตัวเชื่อมต่อ SharePoint Online โปรดคำนึงถึงข้อควรพิจารณาต่อไปนี้

การตั้งค่า SharePoint ที่ใช้

ตัวเชื่อมต่อจะใช้การตั้งค่าระดับการเข้าถึงการค้นหาใน SharePoint เสมอ สำหรับเอกสารฉบับร่าง สิทธิ์ในบัญชีผู้ใช้ที่ตัวเชื่อมต่อใช้เพื่อเข้าถึง SharePoint Online จะควบคุมเอกสารฉบับร่างที่ตัวเชื่อมต่อจัดทำดัชนีและแสดง หากบัญชีมีสิทธิ์ "อ่านทั้งหมด" เท่านั้น ตัวเชื่อมต่อจะใช้การตั้งค่า "ระดับการมองเห็นของรายการฉบับร่าง"

นอกจากนี้ คุณยังกำหนดค่าตัวเชื่อมต่อเพื่อจำกัดผลลัพธ์ตามสิทธิ์เข้าถึงบัญชีผู้ใช้ได้ด้วย หากต้องการใช้การตัดแต่งความปลอดภัย ให้ซิงค์ข้อมูลประจำตัวภายนอกเหล่านี้กับ Google Cloud Directory โดยทำดังนี้

ผู้ใช้ Office 365 / Azure AD
กลุ่มความปลอดภัยของ Office 365 / Azure AD
กลุ่ม SharePoint (มีผู้ใช้และกลุ่ม Office 365 เป็นสมาชิก)

การเพิ่มประสิทธิภาพการค้นหา

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

หากต้องการตั้งค่าสคีมา โปรดดูสร้างและลงทะเบียนสคีมา เมื่อตั้งค่าสคีมา ให้ทำดังนี้

เครื่องมือเชื่อมต่อจะแปลงประเภทเนื้อหา SharePoint ให้เป็นชื่อคำจำกัดความออบเจ็กต์ที่ถูกต้อง (A-Z, a-z, 0-9) เช่น "บทความข่าว" จะกลายเป็น "NewsArticle"
หากเครื่องมือเชื่อมต่อจับคู่คำจำกัดความออบเจ็กต์ไม่ได้ เครื่องมือจะใช้ประเภทออบเจ็กต์สำรอง (itemMetadata.objectType) ดูพารามิเตอร์การกำหนดค่าข้อมูลเมตา
ตัวเชื่อมต่อจะแมปชื่อพร็อพเพอร์ตี้ SharePoint กับคำจำกัดความของพร็อพเพอร์ตี้
ตัวเชื่อมต่อจะลบล้างประเภทสื่อสำหรับไฟล์ .msg ของ Microsoft Outlook และจัดทำดัชนีเป็น application/vnd.ms-outlook

ข้อจำกัดที่ทราบของตัวเชื่อมต่อ

อินสแตนซ์ของเครื่องมือเชื่อมต่อแต่ละรายการจะจัดทำดัชนีเนื้อหาจากคอลเล็กชันเว็บไซต์เดียวเท่านั้น หากต้องการจัดทำดัชนีคอลเล็กชันเว็บไซต์หลายรายการ ให้ตั้งค่าอินสแตนซ์เพิ่มเติม
การใช้หน่วยความจำจะเพิ่มขึ้นตามจำนวนผู้ใช้และกลุ่มที่ไม่ซ้ำใน ACL
การลบการแจ้งเตือนอาจใช้เวลานานกว่า 4 ชั่วโมงจึงจะมีผล

ข้อกำหนดของระบบ

ข้อกำหนดของระบบ
ระบบปฏิบัติการ	Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0 หรือ SUSE Enterprise Linux 10 (64 บิต)
การตรวจสอบสิทธิ์	การตรวจสอบสิทธิ์ที่มีอยู่
ซอฟต์แวร์	สภาพแวดล้อม SharePoint Online, Java JRE 1.8

ติดตั้งใช้งานเครื่องมือเชื่อมต่อ

ทำตามขั้นตอนต่อไปนี้เพื่อติดตั้งใช้งานตัวเชื่อมต่อ SharePoint Online

ข้อกำหนดเบื้องต้น

สร้างคีย์ส่วนตัวของ Google Workspace ดู กำหนดค่าการเข้าถึง Cloud Search API
เพิ่มแหล่งข้อมูลเพื่อค้นหาและบันทึกรหัสของแหล่งข้อมูล ดูเพิ่มแหล่งข้อมูลเพื่อค้นหา
สำหรับผลลัพธ์ที่อิงตาม ACL ผู้ดูแลระบบต้องสร้างแหล่งข้อมูลประจำตัว 2 แหล่ง (แหล่งหนึ่งสำหรับ Office 365 และอีกแหล่งหนึ่งสำหรับกลุ่ม SharePoint) และระบุ รหัสลูกค้า Google Workspace ดูแมปข้อมูลประจำตัวของผู้ใช้
ตั้งค่าบัญชีผู้ใช้สำหรับตัวเชื่อมต่อที่มีสิทธิ์ระดับผู้ดูแลระบบคอลเล็กชันเว็บไซต์ SharePoint Online
สร้างข้อมูลเข้าสู่ระบบแอปพลิเคชัน Azure Active Directory ที่มีสิทธิ์ Group.Read.All และ User.Read.All จดรหัสแอปพลิเคชัน ผู้เช่า และรหัสลับไคลเอ็นต์

ขั้นตอนที่ 1 ติดตั้งซอฟต์แวร์ตัวเชื่อมต่อ

โคลนที่เก็บ

$ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
$ cd sharepoint-connector

ดูเวอร์ชันที่คุณเลือก (เช่น v1-0.0.3):
```
$ git checkout tags/v1-0.0.3
```
สร้างเครื่องมือเชื่อมต่อ
```
$ mvn package
```
หากต้องการข้ามการทดสอบ ให้ใช้ mvn package -DskipTests
แตกไฟล์ ZIP ไปยังไดเรกทอรีการติดตั้ง

ขั้นตอนที่ 2 สร้างไฟล์การกำหนดค่า

สร้าง sharepoint-online-connector.config ในไดเรกทอรีการติดตั้ง เพิ่ม พารามิเตอร์เป็นคู่คีย์-ค่า ดังที่แสดงในตัวอย่างต่อไปนี้

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=password
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE
api.identitySourceId=08ef8becd116faa475de26d9b291fed9
api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

ดูรายละเอียดได้ที่ข้อมูลอ้างอิงหรือ พารามิเตอร์ที่ Google จัดหาให้

ขั้นตอนที่ 3 ตั้งค่าการบันทึก

สร้างโฟลเดอร์ logs และไฟล์ logging.properties ที่มีเนื้อหานี้

   handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
   # Default log level
   .level = INFO

   # uncomment line below to increase logging level for SharePoint APIsa
   #com.google.enterprise.cloudsearch.sharepoint.level=FINE

   # uncomment line below to increase logging level to enable API trace
   #com.google.api.client.http.level = FINE
   java.util.logging.ConsoleHandler.level = INFO
   java.util.logging.FileHandler.pattern=logs/connector-sharepoint.%g.log
   java.util.logging.FileHandler.limit=10485760
   java.util.logging.FileHandler.count=10
   java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

ขั้นตอนที่ 4 กำหนดค่าเครื่องมือเชื่อมต่อข้อมูลประจำตัวของ SharePoint

หากต้องการใช้ ACL ตามข้อมูลประจำตัว ให้สร้าง sharepoint-online-identity-connector.configด้วย api.customerId และ พารามิเตอร์การเชื่อมต่ออื่นๆ ตามตัวอย่างต่อไปนี้

```properties
### SharePoint Online identity connector configuration ###
# Required parameters for data source access
api.customerId=C05d3djk8
api.serviceAccountPrivateKeyFile=service_account.json

# Required parameters for SharePoint Online access
sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=pa$sw0rd
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE

# SharePoint identity mapping parameters
api.identitySourceId=08ef8becd116faa475de26d9b291fed9
api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa
```

ขั้นตอนที่ 5 ติดตั้งโปรแกรมเชื่อมต่อข้อมูลประจำตัวของ Office 365

หากคุณใช้ ACL ที่อิงตามข้อมูลประจำตัวของ SharePoint Online ให้ทำขั้นตอนนี้ หากใช้ ACL สาธารณะ ให้ข้ามขั้นตอนนี้

โคลนที่เก็บ Office 365

$ git clone https://github.com/google-cloudsearch/office-365-connector.git
$ cd office-365-connector

ดูและสร้างเครื่องมือเชื่อมต่อโดยใช้ mvn package
แตกไฟล์ ZIP ไปยังไดเรกทอรีการติดตั้ง

ขั้นตอนที่ 6 กำหนดค่าตัวเชื่อมต่อข้อมูลประจำตัวของ Office 365

ในไดเรกทอรีเดียวกับการติดตั้งตัวเชื่อมต่อข้อมูลประจำตัว ให้สร้างไฟล์ ชื่อ o365-identity-connector.config และเพิ่มพารามิเตอร์เป็นคู่คีย์-ค่า
```
### Office 365 Identity connector configuration ###
api.identitySourceId=<var>12345abcde</var>
api.customerId=<var>abcde12345</var>
o365.clientId=<var>a63c6eb3-29e7-486</var>
o365.tenant=<var>185ef9ed-29e7-486</var>
o365.clientSecret=<var>raHJN15vRLBKs</var>
```
ดูคำอธิบายพารามิเตอร์ได้ที่เครื่องมือเชื่อมต่อข้อมูลประจำตัวของ Office 365
ในไดเรกทอรีเดียวกัน ให้สร้างโฟลเดอร์ชื่อ logs

ในไดเรกทอรีเดียวกัน ให้สร้างไฟล์ชื่อ logging.properties ที่มีเนื้อหาต่อไปนี้

   handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
   # Default log level
   .level = INFO
   # uncomment line below to increase logging level for Office 365 APIs
   #com.google.enterprise.cloudsearch.o365.level=FINE

   # uncomment line below to increase logging level to enable Google API traces
   #com.google.api.client.http.level = FINE
   java.util.logging.ConsoleHandler.level = INFO
   java.util.logging.FileHandler.pattern=logs/connector-o365.%g.log
   java.util.logging.FileHandler.limit=10485760
   java.util.logging.FileHandler.count=10
   java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

ขั้นตอนที่ 7 เปิดใช้เครื่องมือเชื่อมต่อ

หลังจากกำหนดค่าเครื่องมือเชื่อมต่อแล้ว ให้เรียกใช้เพื่อเริ่มการซิงค์และ การจัดทำดัชนี เรียกใช้แต่ละคำสั่งในหน้าต่างเทอร์มินัลของตัวเอง

เรียกใช้ตัวเชื่อมต่อข้อมูลประจำตัวของ Office 365 เพื่อซิงค์ผู้ใช้และกลุ่ม
```
$ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-office-365-connector-v1-0.0.3.jar -Dconfig=o365-identity-connector.config
```
เรียกใช้ตัวเชื่อมต่อข้อมูลประจำตัวของ SharePoint Online เพื่อซิงค์กลุ่มคอลเล็กชันเว็บไซต์
```
$ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -Dconfig=sharepoint-online-identity-connector.config
```

เรียกใช้ตัวเชื่อมต่อ SharePoint Online เพื่อจัดทำดัชนีเนื้อหา

$ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -Dconfig=sharepoint-online-connector.config

ข้อมูลอ้างอิงพารามิเตอร์การกําหนดค่า

ส่วนต่อไปนี้แสดงพารามิเตอร์การกำหนดค่าที่ใช้ในการกำหนดค่า เครื่องมือเชื่อมต่อ SharePoint Online

การเข้าถึงแหล่งข้อมูล

การตั้งค่า	พารามิเตอร์
รหัสแหล่งข้อมูล	`api.sourceId=1234567890abcdef` ต้องระบุ รหัสแหล่งข้อมูล Google Cloud Search ที่ผู้ดูแลระบบ Google Workspace ตั้งค่าไว้
เส้นทางไปยังไฟล์คีย์ส่วนตัวของบัญชีบริการ	`api.serviceAccountPrivateKeyFile=PrivateKey.json` ต้องระบุ เส้นทางไปยังไฟล์คีย์บัญชีบริการของ Google Cloud Search

การเข้าถึง SharePoint Online

การตั้งค่า	พารามิเตอร์
ชื่อโดเมนที่สมบูรณ์ในตัวเองสำหรับคอลเล็กชันเว็บไซต์ SharePoint	`sharepoint.server=``http://yoursharepoint.example.com/` ต้องระบุ หากชื่อโดเมนไม่สมบูรณ์ ให้ตั้งค่าการลบล้าง DNS ในโฮสต์ตัวเชื่อมต่อ
โหมดคอลเล็กชันเว็บไซต์เท่านั้น	`sharepoint.siteCollectionOnly=true` ต้องระบุ สำหรับ SharePoint Online ให้ตั้งค่าเป็น `true`
ชื่อผู้ใช้ SharePoint	`sharepoint.username=username` ต้องระบุ ชื่อผู้ใช้สำหรับบัญชีที่ใช้เข้าถึง SharePoint Online
รหัสผ่าน SharePoint	`sharepoint.password=user_password` ต้องระบุ รหัสผ่านของบัญชีที่ใช้เพื่อเข้าถึง SharePoint Online
โหมดการตรวจสอบสิทธิ์	`sharepoint.formsAuthenticationMode=LIVE` ต้องระบุ สำหรับ SharePoint Online ค่าจะเป็น `LIVE` เสมอ
ประเภทการติดตั้งใช้งาน	`sharepoint.deploymentType=ONLINE` ต้องระบุ สำหรับ SharePoint Online ค่าจะเป็น `ONLINE` เสมอ

การจับคู่ข้อมูลประจำตัวของ SharePoint

การตั้งค่า	พารามิเตอร์
รหัสแหล่งที่มาของข้อมูลประจำตัว	`api.identitySourceId=1234567890abcdef` ต้องระบุ รหัสแหล่งที่มาของข้อมูลประจำตัว Cloud Search สำหรับแหล่งที่มาของข้อมูลประจำตัวของกลุ่ม SharePoint
อ้างอิงแหล่งที่มาของข้อมูลประจำตัว	`api.referenceIdentitySources=defaultIdentitySource` ต้องระบุ สำหรับ SharePoint Online ค่าจะเป็น `defaultIdentitySource` เสมอ
รหัสแหล่งที่มาของข้อมูลประจำตัวอ้างอิง	`api.referenceIdentitySource.defaultIdentitySource.id=112233abcd` ต้องระบุ รหัสแหล่งที่มาของข้อมูลประจำตัว Cloud Search สำหรับแหล่งที่มาของข้อมูลประจำตัวผู้ใช้และกลุ่ม Office 365

การสร้างเนื้อหา HTML

การตั้งค่า	พารามิเตอร์
ฟิลด์ชื่อเทมเพลต HTML	`contentTemplate.sharePointItem.title=Title` ฟิลด์ SharePoint ที่จะใช้เป็นชื่อเทมเพลต HTML สำหรับ HTML ที่สร้างขึ้น
ฟิลด์คุณภาพการค้นหาสูงของเนื้อหา HTML	`contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]` รายการฟิลด์ที่คั่นด้วยคอมมาเพื่อรวมไว้ใน HTML ที่สร้างขึ้นเป็นฟิลด์คุณภาพสูง เมื่อคำในคำค้นหาตรงกับช่องเหล่านี้ ระบบจะจัดอันดับผลการค้นหาให้สูงขึ้น
ฟิลด์คุณภาพการค้นหาปานกลางของเนื้อหา HTML	`contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]` รายการฟิลด์ที่คั่นด้วยคอมมาซึ่งจะรวมไว้ใน HTML ที่สร้างขึ้นเป็นฟิลด์คุณภาพปานกลาง
ฟิลด์คุณภาพการค้นหาต่ำของเนื้อหา HTML	`contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]` รายการฟิลด์ที่คั่นด้วยคอมมาเพื่อรวมไว้ใน HTML ที่สร้างขึ้นเป็นฟิลด์คุณภาพต่ำ
คอลัมน์เนื้อหา HTML ที่ไม่ได้แมป	`contentTemplate.sharepointItem.unmappedColumnsMode=APPEND` วิธีที่เครื่องมือเชื่อมต่อจัดการกับคอลัมน์ที่ไม่ได้แมป ค่าคือ APPEND (ค่าเริ่มต้น) หรือ IGNORE APPEND - ตัวเชื่อมต่อจะสร้างเนื้อหา HTML ที่มีช่องทั้งหมด รวมถึงช่องที่ไม่ได้ตั้งค่าระดับคุณภาพ (สูง ปานกลาง หรือต่ำ) IGNORE - ตัวเชื่อมต่อจะสร้างเนื้อหา HTML ที่มีเฉพาะฟิลด์ที่แมป

การกำหนดค่าตัวเชื่อมต่อข้อมูลประจำตัว Office 365

การตั้งค่า	พารามิเตอร์
รหัสแหล่งที่มาของข้อมูลประจำตัว	`api.identitySourceId=1234567890abcdef` ต้องระบุ รหัสแหล่งที่มาของข้อมูลประจำตัว Office 365 ค่านี้ควรตรงกับค่าของ `api.referenceIdentitySource.defaultIdentitySource.id` ในการกำหนดค่าตัวเชื่อมต่อ SharePoint Online
รหัสลูกค้า Google	`api.customerId=c1b1d1e1` ต้องระบุ รหัสลูกค้า Google Workspace ขององค์กร
รหัสแอปพลิเคชัน Office 365	`o365.clientId=a63c6eb3-29e7-486` ต้องระบุ รหัสแอปพลิเคชันจากการตั้งค่าแอปพลิเคชัน Office 365
ผู้เช่า Office 365	`o365.tenant=185ef9ed-29e7-486` ต้องระบุ กลุ่มผู้ใช้สำหรับบัญชี Office 365 (แอป Azure Activity Directory)
รหัสลับไคลเอ็นต์ของ Office 365	`o365.clientSecret=raHJN15vRLBKs` ต้องระบุ รหัสลับของข้อมูลเข้าสู่ระบบจากการตั้งค่าแอปพลิเคชัน Office 365