Triển khai trình kết nối Microsoft SharePoint Online

Bạn có thể thiết lập Google Cloud Search để trả về kết quả từ nội dung trên SharePoint Online của tổ chức, ngoài nội dung trên Google Workspace. Sử dụng trình kết nối Cloud Search SharePoint Online và định cấu hình trình kết nối này để truy cập vào một nguồn dữ liệu cụ thể trên SharePoint Online.

Điểm quan trọng cần lưu ý

Trước khi triển khai trình kết nối SharePoint Online, hãy lưu ý những điểm cần cân nhắc sau.

Các chế độ cài đặt được hỗ trợ của SharePoint

Trình kết nối luôn tuân thủ chế độ cài đặt Khả năng hiển thị khi tìm kiếm trên SharePoint. Đối với tài liệu nháp, các quyền trên tài khoản người dùng mà trình kết nối dùng để truy cập vào SharePoint Online sẽ kiểm soát những tài liệu nháp mà trình kết nối lập chỉ mục và trả về. Nếu tài khoản chỉ có quyền "Đọc toàn bộ", thì trình kết nối sẽ tuân theo chế độ cài đặt "Hiển thị mục nháp".

Bạn cũng có thể định cấu hình trình kết nối để giới hạn kết quả dựa trên quyền truy cập vào tài khoản người dùng. Để áp dụng tính năng cắt bớt bảo mật, hãy đồng bộ hoá các danh tính bên ngoài này với Google Cloud Directory:

Người dùng Office 365 / Azure AD.
Nhóm bảo mật Office 365 / Azure AD.
Nhóm SharePoint (có người dùng và nhóm Office 365 là thành viên).

Tối ưu hoá công cụ tìm kiếm

Cải thiện trải nghiệm tìm kiếm bằng cách định cấu hình trình kết nối để trả về các kết quả có liên quan. Sử dụng các tham số tạo HTML trong tệp cấu hình để đặt các cấp độ tác động của trường.

Để thiết lập giản đồ, hãy xem phần Tạo và đăng ký giản đồ. Khi thiết lập giản đồ:

Trình kết nối chuẩn hoá các loại nội dung SharePoint thành tên định nghĩa đối tượng hợp lệ (A-Z, a-z, 0-9). Ví dụ: "News Article" (Bài viết tin tức) sẽ trở thành "NewsArticle".
Nếu không thể so khớp một định nghĩa đối tượng, trình kết nối sẽ sử dụng loại đối tượng dự phòng (itemMetadata.objectType). Hãy xem Các thông số cấu hình siêu dữ liệu.
Trình kết nối liên kết tên thuộc tính SharePoint với định nghĩa thuộc tính.
Trình kết nối ghi đè loại phương tiện cho các tệp .msg của Microsoft Outlook và lập chỉ mục các tệp đó dưới dạng application/vnd.ms-outlook.

Các hạn chế đã biết của trình kết nối

Mỗi phiên bản trình kết nối chỉ lập chỉ mục nội dung từ một tuyển tập trang duy nhất. Để lập chỉ mục nhiều tuyển tập trang web, hãy thiết lập các phiên bản bổ sung.
Mức tiêu thụ bộ nhớ tăng lên theo số lượng người dùng và nhóm riêng biệt trong danh sách kiểm soát truy cập (ACL).
Quá trình xoá thông báo có thể mất hơn 4 giờ để có hiệu lực.

Yêu cầu hệ thống

Yêu cầu hệ thống
Hệ điều hành	Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0 hoặc SUSE Enterprise Linux 10 (64 bit).
Xác thực	Xác thực trực tiếp.
Phần mềm	Môi trường SharePoint Online; Java JRE 1.8.

Triển khai trình kết nối

Làm theo các bước sau để triển khai trình kết nối SharePoint Online.

Điều kiện tiên quyết

Tạo khoá riêng tư Google Workspace. Xem phần Định cấu hình quyền truy cập vào Cloud Search API.
Thêm một nguồn dữ liệu để tìm kiếm và ghi lại mã nhận dạng của nguồn dữ liệu đó. Xem phần Thêm nguồn dữ liệu để tìm kiếm.
Đối với kết quả dựa trên ACL, quản trị viên của bạn phải tạo 2 nguồn nhận dạng (một cho Office 365 và một cho các nhóm SharePoint) rồi cung cấp mã khách hàng Google Workspace. Xem phần Ánh xạ danh tính người dùng.
Thiết lập tài khoản người dùng cho trình kết nối có đặc quyền Quản trị viên bộ sưu tập trang web SharePoint Online.
Tạo thông tin đăng nhập của ứng dụng Azure Active Directory với các quyền Group.Read.All và User.Read.All. Ghi lại Mã ứng dụng, Người thuê và Khoá bí mật của ứng dụng khách.

Bước 1. Cài đặt phần mềm trình kết nối

Sao chép kho lưu trữ:

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

Kiểm tra phiên bản bạn chọn (ví dụ: v1-0.0.3):
```
$ git checkout tags/v1-0.0.3
```
Tạo trình kết nối:
```
$ mvn package
```
Để bỏ qua các bài kiểm thử, hãy dùng mvn package -DskipTests.
Giải nén tệp ZIP vào thư mục cài đặt.

Bước 2. Tạo tệp cấu hình

Tạo sharepoint-online-connector.config trong thư mục cài đặt. Thêm các tham số dưới dạng cặp khoá-giá trị, như minh hoạ trong ví dụ sau:

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

Hãy xem tài liệu tham khảo hoặc các tham số do Google cung cấp để biết thông tin chi tiết.

Bước 3. Thiết lập tính năng ghi nhật ký

Tạo thư mục logs và tệp logging.properties có nội dung sau:

   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

Bước 4. Định cấu hình trình kết nối danh tính SharePoint

Để áp dụng ACL dựa trên danh tính, hãy tạo sharepoint-online-identity-connector.config bằng api.customerId và các thông số kết nối khác như trong ví dụ sau:

```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
```

Bước 5. Cài đặt trình kết nối danh tính Office 365

Nếu bạn đang sử dụng ACL dựa trên danh tính của SharePoint Online, hãy thực hiện bước này. Nếu bạn đang sử dụng ACL công khai, hãy bỏ qua bước này.

Sao chép kho lưu trữ Office 365:

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

Kiểm tra và tạo trình kết nối bằng mvn package.
Giải nén tệp ZIP vào thư mục cài đặt.

Bước 6. Định cấu hình trình kết nối danh tính Office 365

Trong cùng thư mục với quá trình cài đặt trình kết nối danh tính, hãy tạo một tệp có tên o365-identity-connector.config rồi thêm các tham số dưới dạng cặp khoá-giá trị:
```
### 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>
```
Để biết nội dung mô tả tham số, hãy xem Trình kết nối danh tính Office 365.
Trong cùng một thư mục, hãy tạo một thư mục có tên là logs.

Trong cùng một thư mục, hãy tạo một tệp có tên logging.properties với nội dung sau:

   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

Bước 7. Chạy trình kết nối

Sau khi bạn định cấu hình các trình kết nối, hãy chạy chúng để bắt đầu quá trình đồng bộ hoá và lập chỉ mục. Chạy từng lệnh trong cửa sổ dòng lệnh riêng.

Chạy trình kết nối danh tính Office 365 để đồng bộ hoá người dùng và nhóm:

$ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-office-365-connector-v1-0.0.3.jar -Dconfig=o365-identity-connector.config

Chạy trình kết nối danh tính SharePoint Online để đồng bộ hoá các nhóm tuyển tập trang web:

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

Chạy trình kết nối SharePoint Online để lập chỉ mục nội dung:

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

Tài liệu tham khảo về thông số cấu hình

Các phần sau đây liệt kê các thông số cấu hình dùng để định cấu hình trình kết nối SharePoint Online.

Truy cập nguồn dữ liệu

Cài đặt	Tham số
Mã nguồn dữ liệu	`api.sourceId=1234567890abcdef` Bắt buộc. Mã nguồn dữ liệu Google Cloud Search do quản trị viên Google Workspace thiết lập.
Đường dẫn đến tệp khoá riêng tư của tài khoản dịch vụ	`api.serviceAccountPrivateKeyFile=PrivateKey.json` Bắt buộc. Đường dẫn đến tệp khoá tài khoản dịch vụ Google Cloud Search.

Quyền truy cập vào SharePoint Online

Cài đặt	Tham số
Tên miền đủ điều kiện cho tuyển tập trang web SharePoint	`sharepoint.server=``http://yoursharepoint.example.com/` Bắt buộc. Nếu tên miền không đủ điều kiện, hãy thiết lập chế độ ghi đè DNS trên máy chủ lưu trữ trình kết nối.
Chế độ Chỉ có thể xem bộ sưu tập trang web	`sharepoint.siteCollectionOnly=true` Bắt buộc. Đối với SharePoint Online, hãy đặt giá trị `true`.
Tên người dùng SharePoint	`sharepoint.username=username` Bắt buộc. Tên người dùng của tài khoản được dùng để truy cập vào SharePoint Online.
Mật khẩu SharePoint	`sharepoint.password=user_password` Bắt buộc. Mật khẩu của tài khoản dùng để truy cập vào SharePoint Online.
Chế độ xác thực	`sharepoint.formsAuthenticationMode=LIVE` Bắt buộc. Đối với SharePoint Online, giá trị này luôn là "LIVE".
Loại hình triển khai	`sharepoint.deploymentType=ONLINE` Bắt buộc. Đối với SharePoint Online, giá trị này luôn là "TRỰC TUYẾN".

Ánh xạ danh tính trên SharePoint

Cài đặt	Tham số
Mã nguồn nhận dạng	`api.identitySourceId=1234567890abcdef` Bắt buộc. Mã nguồn nhận dạng Cloud Search cho nguồn nhận dạng nhóm SharePoint.
Tham chiếu nguồn nhận dạng	`api.referenceIdentitySources=defaultIdentitySource` Bắt buộc. Đối với SharePoint Online, giá trị này luôn là "defaultIdentitySource".
Mã tham chiếu nguồn nhận dạng	`api.referenceIdentitySource.defaultIdentitySource.id=112233abcd` Bắt buộc. Mã nguồn nhận dạng Cloud Search cho nguồn nhận dạng Người dùng và Nhóm Office 365.

Tạo nội dung HTML

Cài đặt	Tham số
Trường tiêu đề mẫu HTML	`contentTemplate.sharePointItem.title=Title` Trường SharePoint dùng làm tiêu đề mẫu HTML cho HTML được tạo.
Các trường có chất lượng tìm kiếm cao của nội dung HTML	`contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]` Một danh sách các trường được phân tách bằng dấu phẩy để đưa vào HTML đã tạo dưới dạng các trường chất lượng cao. Khi các cụm từ tìm kiếm khớp với những trường này, kết quả sẽ được xếp hạng cao hơn.
Các trường chất lượng tìm kiếm trung bình của nội dung HTML	`contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]` Danh sách các trường được phân tách bằng dấu phẩy để đưa vào HTML đã tạo dưới dạng các trường có chất lượng trung bình.
Các trường chất lượng tìm kiếm thấp của nội dung HTML	`contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]` Một danh sách các trường được phân tách bằng dấu phẩy để đưa vào HTML đã tạo dưới dạng các trường có chất lượng thấp.
Cột nội dung HTML chưa được liên kết	`contentTemplate.sharepointItem.unmappedColumnsMode=APPEND` Cách trình kết nối xử lý các cột chưa được liên kết. Giá trị là APPEND (mặc định) hoặc IGNORE. APPEND (Nối) – Trình kết nối tạo nội dung HTML với tất cả các trường, kể cả những trường không được đặt ở mức chất lượng (cao, trung bình hoặc thấp). BỎ QUA – Trình kết nối chỉ tạo nội dung HTML với các trường được liên kết.

Cấu hình trình kết nối danh tính Office 365

Cài đặt	Tham số
Mã nguồn nhận dạng	`api.identitySourceId=1234567890abcdef` Bắt buộc. Mã nguồn nhận dạng Office 365. Giá trị này phải khớp với giá trị của `api.referenceIdentitySource.defaultIdentitySource.id` trong cấu hình trình kết nối SharePoint Online.
Mã khách hàng của Google	`api.customerId=c1b1d1e1` Bắt buộc. Mã khách hàng Google Workspace của tổ chức bạn.
Mã ứng dụng Office 365	`o365.clientId=a63c6eb3-29e7-486` Bắt buộc. Mã ứng dụng trong chế độ thiết lập ứng dụng Office 365.
Đối tượng thuê Office 365	`o365.tenant=185ef9ed-29e7-486` Bắt buộc. Đối tượng thuê bao cho tài khoản Office 365 của bạn (ứng dụng Azure Activity Directory)
Khoá bí mật của ứng dụng khách Office 365	`o365.clientSecret=raHJN15vRLBKs` Bắt buộc. Khoá bí mật của thông tin đăng nhập từ chế độ thiết lập Ứng dụng Office 365