Menerapkan konektor Microsoft SharePoint Online

Panduan ini ditujukan untuk administrator konektor Google Cloud Search SharePoint Online, yaitu siapa saja yang bertanggung jawab untuk mendownload, mengonfigurasi, menjalankan, dan memantau konektor tersebut.

Panduan ini berisi petunjuk untuk melakukan beberapa tugas utama yang terkait dengan penerapan konektor SharePoint Online:

  • Mendownload software konektor Google Cloud Search SharePoint Online
  • Mengonfigurasi konektor untuk digunakan dengan sumber data SharePoint Online tertentu
  • Menerapkan dan menjalankan konektor

Untuk memahami berbagai konsep dalam dokumen ini, Anda harus sudah mengetahui dasar-dasar Google Workspace dan SharePoint lokal.

Ringkasan tentang konektor Google Cloud Search SharePoint Online

Secara default, Google Cloud Search dapat menemukan, mengindeks, dan menyajikan konten dari data Google Workspace seperti Google Dokumen dan Gmail. Anda dapat memperluas jangkauan Google Cloud Search untuk menyertakan penyajian konten SharePoint Online kepada pengguna Anda menggunakan konektor Sharepoint Online.

Mengonfigurasi file properti

Untuk mengaktifkan konektor agar dapat menemukan konten dari SharePoint Online dan menguploadnya ke indexing API, Anda, sebagai administrator konektor, harus membuat file konfigurasi untuk memberikan setelan ke konektor SharePoint Online menggunakan langkah-langkah yang dijelaskan di sini.

Selain parameter konektor SharePoint Online yang dijelaskan dalam dokumen ini, ada parameter konfigurasi yang digunakan oleh semua konektor Cloud Search. Untuk mengetahui informasi selengkapnya, lihat Parameter konektor yang disediakan Google.

Sistem operasi yang didukung

Konektor Cloud Search SharePoint Online mendukung sistem operasi berikut:

  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 bit)

Mengindeks dokumen yang tidak dipublikasikan

Konektor Cloud Search SharePoint Online selalu menerapkan setelan Search Visibility di SharePoint (Anda tidak dapat mengganti setelan ini). Untuk draf dokumen, pengindeksan bergantung pada izin yang diberikan ke akun pengguna konektor. Jika pengguna hanya memiliki izin "Baca Penuh", konektor akan menerapkan semua setelan "Visibilitas item draf" di SharePoint.

Mekanisme autentikasi yang didukung

Konektor Cloud Search SharePoint Online mendukung Live Authentication.

Batasan umum konektor

  • Instance konektor hanya dapat mengindeks konten dari satu kumpulan situs. Anda memerlukan instance konektor terpisah untuk mengindeks beberapa kumpulan situs.
  • Jumlah pengguna dan grup unik yang digunakan dalam ACL untuk setiap kumpulan situs akan memengaruhi pemakaian memori.
  • Versi konektor saat ini tidak menghasilkan notifikasi penghapusan instan.
  • Konektor bergantung pada pengindeksan ulang konten untuk mengidentifikasi penghapusan dari repositori sumber. Untuk konten yang telah diindeks sebelumnya, latensi deteksi penghapusan dapat memakan waktu lebih dari 4 jam.

Prasyarat

Konektor Google Cloud Search SharePoint Online dapat diinstal di Linux atau Windows. Sebelum Anda menerapkan konektor Google Cloud Search SharePoint Online, pastikan Anda memiliki komponen prasyarat berikut:

  • Lingkungan SharePoint Online.
  • Java JRE 1.8 yang diinstal pada komputer yang menjalankan konektor Google Cloud Search SharePoint Online
  • Informasi Google Workspace yang diperlukan untuk menghubungkan Google Cloud Search dan sumber data:

    Biasanya, administrator Google Workspace untuk domain dapat memberikan kredensial tersebut kepada Anda.

  • Akun pengguna untuk konektor. Akun ini harus memiliki hak istimewa Administrator Kumpulan Situs.

Langkah-langkah penerapan

Untuk menerapkan konektor Google Cloud Search SharePoint Online, ikuti langkah-langkah berikut:

  1. Instal software konektor Google Cloud Search SharePoint Online
  2. Tentukan konfigurasi konektor SharePoint Online.
  3. Konfigurasikan akses ke sumber data Google Cloud Search.
  4. Konfigurasikan akses ke SharePoint Online
  5. Konfigurasikan Pemetaan Identitas SharePoint dengan Google Cloud Search
  6. Konfigurasikan pembuatan konten HTML dan dukungan data terstruktur untuk Item Daftar SharePoint.
  7. Konfigurasikan Pemetaan Identitas O365 dengan Google Cloud Search
  8. Aktifkan logging.

1. Instal software konektor Google Cloud Search SharePoint Online

Instal SDK ke repositori Maven lokal Anda.

  1. Clone repositori SDK dari GitHub. git clone https://github.com/google-cloudsearch/connector-sdk.git cd connector-sdk
  2. Periksa versi SDK yang diinginkan: git checkout tags/v1-0.0.3
  3. Instal komponen SDK: mvn install

Buat konektor.

  1. Clone repositori konektor dari GitHub. git clone https://github.com/google-cloudsearch/sharepoint-connector.git cd sharepoint-connector
  2. Periksa versi konektor yang diinginkan dan buat file ZIP: git checkout tags/v1-0.0.3 mvn package (Untuk melewati pengujian saat membuat konektor, gunakan mvn package -DskipTests.)

2. Tentukan konfigurasi konektor SharePoint Online

Agar konektor dapat mengakses SharePoint Online dan mengindeks konten dengan benar, Anda harus membuat file konfigurasinya terlebih dahulu. Anda dapat mengontrol perilaku dan atribut konektor SharePoint Online dengan menentukan parameter dalam file konfigurasi konektor. Parameter yang dapat dikonfigurasi mengontrol:

  • Akses ke sumber data
  • Akses ke SharePoint Online

Untuk membuat file konfigurasi:

  1. Buka editor teks pilihan Anda dan tambahkan key=value pair ke konten file seperti yang dijelaskan di bagian berikut.
  2. Simpan dan beri nama file konfigurasi. Google merekomendasikan untuk memberi nama file konfigurasi connector-config.properties sehingga Anda tidak perlu menambahkan parameter command line lain untuk menjalankan konektor.

3. Konfigurasikan akses ke sumber data Google Cloud Search

Parameter pertama yang harus ditentukan oleh setiap file konfigurasi adalah parameter yang diperlukan untuk mengakses sumber data Cloud Search, seperti yang ditunjukkan pada tabel berikut. Biasanya, Anda akan memerlukan ID Sumber data, ID Sumber identitas, dan lokasi ke file kunci pribadi dari akun layanan untuk mengonfigurasi akses konektor ke Cloud Search. Langkah-langkah yang diperlukan untuk menyiapkan sumber data dijelaskan dalam Menambahkan sumber data untuk penelusuran.

Setelan Parameter
ID sumber data api.sourceId=1234567890abcdef Wajib ada. ID sumber Google Cloud Search yang disiapkan oleh administrator Google Workspace.
Lokasi ke file kunci pribadi akun layanan api.serviceAccountPrivateKeyFile=./PrivateKey.json Wajib ada. File kunci akun layanan Google Cloud Search untuk aksesibilitas konektor Google Cloud Search SharePoint Online.
ID sumber identitas api.identitySourceId=x0987654321 Wajib ada. ID sumber identitas Cloud Search yang disiapkan oleh administrator Google Workspace.

4. Konfigurasikan akses ke SharePoint Online

Sebelum konektor dapat mengakses SharePoint Online dan mengekstrak data darinya untuk pengindeksan, Anda harus mengonfigurasi akses ke SharePoint Online. Gunakan parameter berikut untuk menambahkan informasi akses ke file konfigurasi.

Setelan Parameter
Nama domain yang memenuhi syarat sepenuhnya untuk Kumpulan Situs SharePoint sharepoint.server=http://yoursharepoint.example.com/ Wajib ada. Jika nama domain tidak sepenuhnya memenuhi syarat, Anda harus menetapkan penggantian DNS pada host konektor.
Mode Khusus Kumpulan Situs sharepoint.siteCollectionOnly=true Wajib ada. Untuk SharePoint Online, tetapkan parameter ini ke selalu true.
Nama pengguna SharePoint sharepoint.username=username Wajib ada. Nama pengguna untuk akun yang digunakan mengakses SharePoint Online.
Sandi SharePoint sharepoint.password=user_password Wajib ada. Sandi akun yang digunakan untuk mengakses SharePoint Online.
Mode Autentikasi sharepoint.formsAuthenticationMode=LIVE Wajib ada. Untuk SharePoint Online, tetapkan parameter ini ke LIVE.
Jenis Penerapan sharepoint.deploymentType=ONLINE Wajib ada. Untuk SharePoint Online, tetapkan parameter ini ke ONLINE.

5. Konfigurasikan Pemetaan Identitas SharePoint dengan Google Cloud Search

Dengan Google Cloud Search, pelanggan dapat menerapkan pemangkasan ACL pada hasil penelusuran. ACL ini dapat ditentukan menggunakan entity utama Google serta entity utama eksternal.

Konektor SharePoint Online mendukung identitas berikut:

  • Pengguna Office 365/Azure AD
  • Grup keamanan Office 365/Azure AD
  • Grup Lokal SharePoint (dengan pengguna dan grup O365 sebagai anggota)

Untuk menerapkan pemangkasan keamanan yang tepat untuk konten SharePoint, Anda juga perlu menyinkronkan identitas eksternal berikut dengan Google:

  • Gunakan Konektor identitas SharePoint untuk menyinkronkan Grup Lokal SharePoint.
  • Gunakan Konektor identitas O365 Identity untuk menyinkronkan Identitas O365.

Untuk mendukung penyiapan tersebut, Anda perlu membuat 2 Sumber Identitas.

  • Sumber Identitas untuk menyinkronkan Pengguna dan Grup O365.
  • Sumber identitas untuk grup Lokal SharePoint.
Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef ID sumber identitas untuk menyinkronkan Grup Lokal SharePoint

Wajib ada. ID sumber Google Cloud Search yang disiapkan oleh administrator Google Workspace, seperti yang dijelaskan dalam Menambahkan sumber data untuk penelusuran.

Sumber Identitas Referensi api.referenceIdentitySources=defaultIdentitySource Wajib ada. Untuk SharePoint Online, nilai default defaultIdentitySource digunakan
ID Sumber Identitas Referensi api.referenceIdentitySource.defaultIdentitySource.id=112233abcd Wajib ada. ID Sumber Identitas untuk menyinkronkan identitas O365.

6. Konfigurasikan pembuatan konten HTML dan dukungan data terstruktur untuk Item Daftar SharePoint

Guna mengindeks metadata tambahan untuk Item Daftar SharePoint, konfigurasikan konektor untuk mendukung pembuatan konten HTML dan/atau data terstruktur.

Pembuatan konten HTML

Gunakan parameter dalam tabel berikut untuk mengonfigurasi pembuatan konten HTML.

Setelan Parameter
Kolom judul template HTML contentTemplate.sharePointItem.title=Title Kolom SharePoint digunakan sebagai "Judul" untuk HTML yang dihasilkan.
Kolom konten HTML dengan kualitas penelusuran tinggi contentTemplate.sharePointItem.quality.high=highField1,highField2… Kolom yang akan disertakan dalam HTML yang dihasilkan sebagai kolom dengan kualitas tinggi. Pencocokan istilah kueri penelusuran di kolom ini akan diberikan peringkat lebih tinggi.
Kolom konten HTML dengan kualitas penelusuran sedang contentTemplate.sharePointItem.quality.medium=mediumField1, mediumField2… Kolom yang akan disertakan dalam HTML yang dihasilkan sebagai kolom dengan kualitas sedang.
Kolom konten HTML dengan kualitas penelusuran rendah contentTemplate.sharePointItem.quality.low=lowField1, lowField2… Kolom yang akan disertakan dalam HTML yang dihasilkan sebagai kolom dengan kualitas rendah.
Kolom konten HTML yang belum dipetakan contentTemplate.sharepointItem.unmappedColumnsMode=APPEND Defaultnya ditetapkan ke APPEND. Jika ditetapkan ke IGNORE, konektor akan menghasilkan HTML hanya menggunakan kolom yang dipetakan. Tetapkan ke APPEND untuk menyertakan kolom yang belum dipetakan (tidak menjadi bagian dari konfigurasi tinggi, sedang, rendah) dalam konten HTML yang dihasilkan.

Dukungan data terstruktur

Jika skema untuk sumber data ditentukan menggunakan panduan berikut, konektor akan mengisi data terstruktur untuk item daftar SharePoint:

  • Konektor memetakan nama jenis konten SharePoint ke definisi objek yang sesuai dengan menormalkan nama jenis konten SharePoint sesuai dengan spesifikasi yang ditentukan oleh Cloud Search API. Cloud Search API hanya mendukung A-Z, a-z, dan 0-9 sebagai karakter yang valid untuk definisi objek. Konektor menormalkan nama jenis konten dengan mengecualikan karakter yang tidak didukung. Misalnya, jenis konten "Pengumuman" dipetakan ke definisi objek "Pengumuman", sedangkan jenis konten "Artikel Berita" dipetakan ke "ArtikelBerita".

  • Konektor juga mendukung konfigurasi jenis objek fallback melalui konfigurasi itemMetadata.objectType. Konektor menggunakan jenis objek fallback jika tidak ada definisi objek yang sesuai dengan jenis konten SharePoint yang tersedia dalam skema.

  • Konektor memetakan nama properti SharePoint ke definisi properti.

7. Konfigurasikan Pemetaan Identitas O365 dengan Google Cloud Search

Untuk menerapkan pemangkasan keamanan yang tepat bagi konten SharePoint berdasarkan identitas O365, Anda perlu mengonfigurasi konektor identitas O365 yang dipaketkan dengan paket konektor SharePoint Online.

Membuat Konektor Identitas Office 365

Instal SDK ke repositori Maven lokal Anda.

  1. Clone repositori SDK dari GitHub. git clone https://github.com/google-cloudsearch/connector-sdk.git cd connector-sdk
  2. Periksa versi SDK yang diinginkan: git checkout tags/v1-0.0.3
  3. Instal komponen SDK: mvn install

Buat konektor.

  1. Clone repositori konektor dari GitHub. git clone https://github.com/google-cloudsearch/office-365-connector.git cd sharepoint-connector
  2. Periksa versi konektor yang diinginkan dan buat file ZIP: git checkout tags/v1-0.0.3 mvn package (Untuk melewati pengujian saat membuat konektor, gunakan mvn package -DskipTests.)

Mendapatkan kredensial O365

Untuk menggunakan konektor identitas O365, Anda harus memberikan kredensial yang sesuai agar konektor membaca pengguna dan grup dari akun O365. Lihat portal O365 untuk membuat aplikasi Azure Active Directory guna menyiapkan kredensial aplikasi untuk instance konektor Anda. Anda akan menerima item berikut saat menyiapkan kredensial aplikasi O365:

  • ID Aplikasi
  • Tenant
  • Rahasia Klien

Konfigurasi konektor

Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef Wajib ada. ID sumber identitas untuk menyinkronkan Identitas O365.

ID sumber Google Cloud Search yang disiapkan oleh administrator Google Workspace, seperti yang dijelaskan dalam Menambahkan sumber data untuk penelusuran. Nilai ini harus cocok dengan konfigurasi "defaultIdentitySource" di konektor SharePoint Online.

ID Pelanggan Google api.customerId=c1b1d1e1 Wajib ada. ID pelanggan yang dikaitkan dengan domain Google Anda

Untuk mendapatkan ID pelanggan, ikuti petunjuk di sini.

ID Aplikasi O365 o365.clientId=a63c6eb3-29e7-486...

Wajib ada. ID aplikasi untuk penyiapan aplikasi O365.

Tenant O365 o365.tenant=185ef9ed-29e7-486...

Wajib ada. Tenant untuk akun O365 Anda

Rahasia klien O365 o365.clientSecret=raHJN15vRLBKs...

Wajib ada. Rahasia kredensial dari penyiapan Aplikasi O365

Log Konektor

Buat folder bernama logs di direktori yang sama yang berisi biner konektor.

Buat file ASCII atau UTF-8 bernama logging.properties di direktori yang sama dan tambahkan konten berikut:

handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
# Default log level
.level = INFO
# uncomment line below to increase logging level for O365 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-sharepoint.%g.log
java.util.logging.FileHandler.limit=10485760
java.util.logging.FileHandler.count=10
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Menjalankan konektor identitas O365

Jalankan konektor menggunakan cmd.exe di mesin host:

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-o365-identity-connector-v-withlib.jar

Langkah 8 Aktifkan logging

Buat folder bernama logs di direktori yang sama yang berisi biner konektor.

Buat file ASCII atau UTF-8 bernama logging.properties di direktori yang sama dan tambahkan konten berikut:

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

Contoh: File konfigurasi

Contoh file konfigurasi berikut menunjukkan parameter key-value pair yang menentukan contoh perilaku konektor.

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

# Optional
contentTemplate.sharepointItem.title=Title
contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

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

api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Menjalankan konektor identitas SharePoint Online

Agar pengguna memperoleh hasil dalam Cloud Search untuk konten SharePoint yang dapat diakses, penting untuk memetakan entity utama terlebih dahulu di O365 dan kumpulan situs SharePoint untuk identitas di layanan Google Cloud Identity. Sinkronisasi ini dilakukan melalui Konektor identitas O365 dan konektor identitas SharePoint Online. Setelah konektor O365 menyinkronkan pengguna dan grup, jalankan konektor identitas SharePoint Online, seperti yang dijelaskan di bawah, untuk menyinkronkan grup kumpulan situs SharePoint.

Konektor identitas menggunakan file konfigurasi yang mirip dengan yang akan mengindeks konten. Berikut adalah contohnya:

api.customerId=C05d3djk8
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

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

api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Perhatikan penambahan properti api.customerId. Untuk mendapatkan ID pelanggan, ikuti petunjuk di sini

File JAR yang sama yang digunakan untuk mengindeks konten juga berisi konektor identitas. Untuk menjalankannya, masukkan perintah berikut di direktori yang berisi file konfigurasi:

java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-v<version>-withlib.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector

Menjalankan konektor SharePoint Online

Jalankan konektor SharePoint Online menggunakan cmd.exe di mesin host:

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v-withlib.jar

Topik Lanjutan

Informasi di bagian ini berisi penjelasan di luar konfigurasi konektor SharePoint dasar.

Mengganti Content-Type untuk file .msg Microsoft Outlook

Jika menemukan file .msg Outlook saat meng-crawl konten, konektor akan mengganti Content-Type untuk file tersebut dan mengindeksnya sebagai application/vnd.ms-outlook.