Menerapkan konektor Microsoft SharePoint Online

Anda dapat menyiapkan Google Cloud Search untuk menampilkan hasil dari konten SharePoint Online organisasi Anda selain konten Google Workspace Anda. Gunakan konektor Cloud Search SharePoint Online dan konfigurasikan untuk mengakses sumber data SharePoint Online tertentu.

Pertimbangan penting

Sebelum men-deploy konektor SharePoint Online, perhatikan pertimbangan berikut.

Setelan SharePoint yang dipatuhi

Konektor selalu menerapkan setelan Visibilitas Penelusuran di SharePoint. Untuk draf dokumen, izin pada akun pengguna yang digunakan konektor untuk mengakses SharePoint Online mengontrol draf dokumen mana yang diindeks dan ditampilkan. Jika akun hanya memiliki izin "Baca Penuh", konektor akan menerapkan setelan "Visibilitas item draf".

Anda juga mengonfigurasi konektor untuk membatasi hasil berdasarkan akses akun pengguna. Untuk menerapkan pemangkasan keamanan, sinkronkan identitas eksternal ini dengan Google Cloud Directory:

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

Pengoptimalan penelusuran

Tingkatkan pengalaman penelusuran dengan mengonfigurasi konektor untuk menampilkan hasil yang relevan. Gunakan parameter pembuatan HTML dalam file konfigurasi untuk menetapkan tingkat dampak kolom.

Untuk menyiapkan skema, lihat Membuat dan mendaftarkan skema. Saat menyiapkan skema:

  • Konektor menormalkan jenis konten SharePoint ke nama definisi objek yang valid (A-Z, a-z, 0-9). Misalnya, "Artikel Berita" menjadi "ArtikelBerita".
  • Jika konektor tidak dapat mencocokkan definisi objek, konektor akan menggunakan jenis objek fallback (itemMetadata.objectType). Lihat Parameter konfigurasi metadata.
  • Konektor memetakan nama properti SharePoint ke definisi properti.
  • Konektor mengganti jenis media untuk file .msg Microsoft Outlook dan mengindeksnya sebagai application/vnd.ms-outlook.

Batasan umum konektor

  • Setiap instance konektor mengindeks konten hanya dari satu kumpulan situs. Untuk mengindeks beberapa kumpulan situs, siapkan instance tambahan.
  • Penggunaan memori meningkat seiring dengan jumlah pengguna dan grup unik dalam ACL.
  • Penghapusan notifikasi dapat memerlukan waktu lebih dari 4 jam untuk diterapkan.

Persyaratan sistem

Persyaratan sistem
Sistem operasi Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0, atau SUSE Enterprise Linux 10 (64-bit).
Autentikasi Autentikasi Live.
Software Lingkungan SharePoint Online; Java JRE 1.8.

Deploy konektor

Ikuti langkah-langkah berikut untuk men-deploy konektor SharePoint Online.

Prasyarat

  1. Buat kunci pribadi Google Workspace. Lihat Mengonfigurasi akses ke Cloud Search API.
  2. Tambahkan sumber data untuk penelusuran dan catat ID-nya. Lihat Menambahkan sumber data untuk penelusuran.
  3. Untuk hasil berbasis ACL, administrator Anda harus membuat dua sumber identitas (satu untuk grup Office 365 dan satu untuk grup SharePoint) serta memberikan ID pelanggan Google Workspace. Lihat Memetakan identitas pengguna.
  4. Siapkan akun pengguna untuk konektor dengan hak istimewa Administrator Koleksi Situs SharePoint Online.
  5. Buat kredensial aplikasi Azure Active Directory dengan izin Group.Read.All dan User.Read.All. Catat ID Aplikasi, Tenant, dan Rahasia Klien.

Langkah 1. Menginstal software konektor

  1. Buat clone repositori: 
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
$ cd sharepoint-connector
  2. Periksa versi yang Anda pilih (misalnya, v1-0.0.3): 
    $ git checkout tags/v1-0.0.3
  3. Buat konektor: 
    $ mvn package
     Untuk melewati pengujian, gunakan mvn package -DskipTests.
  4. Ekstrak file ZIP ke direktori penginstalan Anda.

Langkah 2. Membuat file konfigurasi

Buat sharepoint-online-connector.config di direktori penginstalan. Tambahkan parameter sebagai key-value pair, seperti yang ditunjukkan dalam contoh berikut:

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

Lihat referensi atau parameter yang disediakan Google untuk mengetahui detailnya.

Langkah 3. Menyiapkan logging

Buat folder logs dan file logging.properties dengan konten ini:

   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

Langkah 4. Mengonfigurasi konektor identitas SharePoint

Untuk menerapkan ACL berbasis identitas, buat sharepoint-online-identity-connector.config dengan api.customerId dan parameter koneksi lainnya seperti dalam contoh berikut:

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

Langkah 5. Menginstal konektor identitas Office 365

Jika Anda menggunakan ACL berbasis identitas SharePoint Online, lakukan langkah ini. Jika Anda menggunakan ACL publik, lewati langkah ini.

  1. Buat clone repositori Office 365:

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

  2. Lihat dan buat konektor menggunakan mvn package.

  3. Ekstrak file ZIP ke direktori penginstalan Anda.

Langkah 6. Mengonfigurasi konektor identitas Office 365

  1. Di direktori yang sama dengan penginstalan konektor identitas, buat file bernama o365-identity-connector.config dan tambahkan parameter sebagai key-value pair:

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

    Untuk deskripsi parameter, lihat Konektor identitas Office 365.

  2. Di direktori yang sama, buat folder bernama logs.

  3. Di direktori yang sama, buat file bernama logging.properties dengan konten berikut:

       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

Langkah 7. Luncurkan konektor

Setelah mengonfigurasi konektor, jalankan konektor untuk memulai sinkronisasi dan pengindeksan. Jalankan setiap perintah di jendela terminalnya sendiri.

  1. Jalankan konektor identitas Office 365 untuk menyinkronkan pengguna dan grup:

    $ 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. Jalankan konektor identitas SharePoint Online untuk menyinkronkan grup kumpulan situs:

    $ 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. Jalankan konektor SharePoint Online untuk mengindeks konten:

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

Referensi parameter konfigurasi

Bagian berikut mencantumkan parameter konfigurasi yang digunakan untuk mengonfigurasi konektor SharePoint Online.

Akses sumber data

Setelan Parameter
ID sumber data api.sourceId=1234567890abcdef

Wajib. ID sumber data Google Cloud Search yang disiapkan oleh administrator Google Workspace.
Lokasi ke file kunci pribadi akun layanan api.serviceAccountPrivateKeyFile=PrivateKey.json

Wajib. Jalur ke file kunci akun layanan Google Cloud Search.

Akses SharePoint Online

Setelan Parameter
Nama domain yang memenuhi syarat sepenuhnya untuk Kumpulan Situs SharePoint sharepoint.server=http://yoursharepoint.example.com/

Wajib. Jika nama domain tidak sepenuhnya memenuhi syarat, tetapkan penggantian DNS pada host konektor.
Mode Khusus Kumpulan Situs sharepoint.siteCollectionOnly=true

Wajib. Untuk SharePoint Online, tetapkan nilai true.
Nama pengguna SharePoint sharepoint.username=username

Wajib. Nama pengguna untuk akun yang digunakan untuk mengakses SharePoint Online.
Sandi SharePoint sharepoint.password=user_password

Wajib. Sandi untuk akun yang digunakan untuk mengakses SharePoint Online.
Mode Autentikasi sharepoint.formsAuthenticationMode=LIVE

Wajib. Untuk SharePoint Online, nilainya selalu `LIVE`.
Jenis Penerapan sharepoint.deploymentType=ONLINE

Wajib. Untuk SharePoint Online, nilainya selalu `ONLINE`.

Pemetaan Identitas SharePoint

Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef

Wajib. ID sumber identitas Cloud Search untuk sumber identitas grup SharePoint.
Sumber Identitas Referensi api.referenceIdentitySources=defaultIdentitySource

Wajib. Untuk SharePoint Online, nilainya selalu `defaultIdentitySource`.
ID Sumber Identitas Referensi api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

Wajib. ID sumber identitas Cloud Search untuk sumber identitas Pengguna dan Grup Office 365.

Pembuatan konten HTML

Setelan Parameter
Kolom judul template HTML contentTemplate.sharePointItem.title=Title

Kolom SharePoint yang akan digunakan sebagai judul template HTML untuk HTML yang dihasilkan.
Kolom konten HTML dengan kualitas penelusuran tinggi contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Daftar kolom yang dipisahkan koma untuk disertakan dalam HTML yang dihasilkan sebagai kolom berkualitas tinggi. Jika istilah kueri penelusuran cocok dengan kolom ini, hasil akan diberi peringkat lebih tinggi.
Kolom konten HTML dengan kualitas penelusuran sedang contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Daftar kolom yang dipisahkan koma untuk disertakan dalam HTML yang dihasilkan sebagai kolom berkualitas sedang.
Kolom konten HTML dengan kualitas penelusuran rendah contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Daftar kolom yang dipisahkan koma untuk disertakan dalam HTML yang dihasilkan sebagai kolom berkualitas rendah.
Kolom konten HTML yang belum dipetakan contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Cara konektor menangani kolom yang tidak dipetakan. Nilainya adalah APPEND (default) atau IGNORE.

  • APPEND—Konektor membuat konten HTML dengan semua kolom, termasuk kolom yang tidak ditetapkan dengan tingkat kualitas (tinggi, sedang, atau rendah).
  • IGNORE—Konektor membuat konten HTML hanya dengan kolom yang dipetakan.

Konfigurasi konektor identitas Office 365

Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef

Wajib. ID sumber identitas Office 365. Nilai ini harus cocok dengan nilai `api.referenceIdentitySource.defaultIdentitySource.id` dalam konfigurasi konektor SharePoint Online.
ID Pelanggan Google api.customerId=c1b1d1e1

Wajib. ID pelanggan Google Workspace organisasi Anda.
ID Aplikasi Office 365 o365.clientId=a63c6eb3-29e7-486

Wajib. ID aplikasi dari penyiapan aplikasi Office 365.
Tenant Office 365 o365.tenant=185ef9ed-29e7-486

Wajib. Tenant untuk akun Office 365 Anda (aplikasi Azure Active Directory Anda)
Rahasia klien Office 365 o365.clientSecret=raHJN15vRLBKs

Wajib. Rahasia kredensial dari penyiapan Aplikasi Office 365