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

คุณสามารถตั้งค่า Google Cloud Search ให้แสดงผลลัพธ์จากเนื้อหา SharePoint Online ขององค์กรนอกเหนือจากเนื้อหา Google Workspace ได้ ใช้เครื่องมือเชื่อมต่อ Cloud Search กับ SharePoint Online แล้วกำหนดค่าให้เข้าถึงแหล่งข้อมูล 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) เช่น "News Article" จะกลายเป็น "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 ใช้งานได้

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

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

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

  1. โคลนที่เก็บโดยใช้คำสั่งต่อไปนี้
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. เช็กเอาต์เวอร์ชันที่เลือก (เช่น v1-0.0.3) โดยใช้คำสั่งต่อไปนี้
    $ git checkout tags/v1-0.0.3
  3. สร้างเครื่องมือเชื่อมต่อโดยใช้คำสั่งต่อไปนี้
    $ mvn package
    หากต้องการข้ามการทดสอบ ให้ใช้คำสั่ง mvn package -DskipTests
  4. แตกไฟล์ 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 สาธารณะ ให้ข้ามขั้นตอนนี้

  1. โคลนที่เก็บ Office 365 โดยใช้คำสั่งต่อไปนี้

    $ git clone https://github.com/google-cloudsearch/office-365-connector.git
    $ cd office-365-connector
    
  2. เช็กเอาต์และสร้างเครื่องมือเชื่อมต่อโดยใช้คำสั่ง mvn package

  3. แตกไฟล์ ZIP ไปยังไดเรกทอรีการติดตั้ง

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

  1. ในไดเรกทอรีเดียวกับการติดตั้งเครื่องมือเชื่อมต่อข้อมูลประจำตัว ให้สร้างไฟล์ชื่อ 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

  2. สร้างโฟลเดอร์ชื่อ logs ในไดเรกทอรีเดียวกัน

  3. สร้างไฟล์ชื่อ 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 เปิดใช้เครื่องมือเชื่อมต่อ

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

  1. เรียกใช้เครื่องมือเชื่อมต่อข้อมูลประจำตัวของ 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
    
  2. เรียกใช้เครื่องมือเชื่อมต่อข้อมูลประจำตัวของ 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
    
  3. เรียกใช้เครื่องมือเชื่อมต่อ 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