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 menggunakan konektor Google Cloud Search SharePoint Online dan mengonfigurasinya untuk mengakses sumber data SharePoint Online tertentu.

Pertimbangan penting

Mengikuti setelan SharePoint

Konektor Cloud Search SharePoint Online selalu menerapkan setelan Search Visibility di SharePoint, yang tidak dapat diganti. Untuk draf dokumen, izin di akun pengguna (yang digunakan konektor untuk mengakses SharePoint Online) mengontrol dokumen draf yang diindeks dan ditampilkan. Jika akun hanya memiliki izin "Baca Penuh", konektor akan memenuhi setelan "Visibilitas item draf" di SharePoint.

Anda juga mengonfigurasi konektor untuk membatasi hasil berdasarkan akses akun pengguna. Guna menerapkan pemangkasan keamanan untuk konten SharePoint, Anda menyinkronkan identitas eksternal berikut dengan Direktori Google:

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

Pengoptimalan penelusuran

Anda dapat meningkatkan pengalaman pengguna dengan mengonfigurasi konektor untuk menampilkan hasil penelusuran yang lebih relevan.

Untuk menggunakan API, tetapkan nilai untuk parameter pembuatan HTML di file konfigurasi konektor Online SharePoint. Parameter ini memungkinkan Anda menetapkan kolom mana yang memiliki dampak lebih tinggi atau lebih rendah pada kecocokan.

Untuk menyiapkan skema, ikuti petunjuk di Membuat dan mendaftarkan skema. Saat Anda menyiapkan skema:

  • Untuk memetakan nama jenis konten SharePoint ke definisi objek yang sesuai, konektor akan menormalkan nama jenis konten dengan mengecualikan karakter yang tidak didukung. Untuk definisi objek, Cloud Search API hanya mendukung A-Z, a-z, dan 0-9 sebagai karakter yang valid. Misalnya, jenis konten "Pengumuman" peta ke definisi objek "Pengumuman". Jenis konten "Artikel Berita" dipetakan ke "ArtikelBerita" (tanpa spasi).

  • Jika konektor tidak dapat cocok dengan definisi objek dengan definisi objek, konektor menggunakan jenis objek penggantian (itemMetadata.objectType). Pelajari parameter konfigurasi metadata lebih lanjut.

  • Konektor memetakan nama properti SharePoint ke definisi properti.

  • Saat menemukan file .msg Microsoft Outlook saat mengindeks konten, konektor akan mengganti jenis konten untuk file dan mengindeksnya sebagai application/vnd.ms-outlook.

Batasan umum konektor

  • Setiap instance konektor dapat mengindeks konten hanya dari satu koleksi situs. Untuk mengindeks beberapa koleksi situs, siapkan instance konektor tambahan.
  • Konsumsi memori meningkat dengan jumlah pengguna dan grup unik yang Anda gunakan dalam ACL untuk setiap koleksi situs.
  • Notifikasi penghapusan tidak langsung muncul dan diperlukan waktu lebih dari 4 jam agar konektor mengenali pengguna menghapus konten dari repositori sumber.

Persyaratan sistem

Persyaratan sistem
Sistem operasi
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 bit)
Autentikasi
  • Autentikasi Live
Software
  • Lingkungan SharePoint Online
  • Java JRE 1.8 yang diinstal di komputer yang akan menjalankan konektor Google Cloud Search SharePoint Online

Men-deploy konektor

Prasyarat

  1. Buat kunci pribadi Google Workspace yang berisi ID akun layanan Anda. Untuk mempelajari cara mendapatkan kunci pribadi, buka Mengonfigurasi akses ke REST API Google Cloud Search.

  2. Administrator Google Workspace harus menambahkan sumber data untuk penelusuran. Catat ID sumber data.

  3. Jika konektor menampilkan hasil berdasarkan ACL (hasilnya tidak untuk publik), administrator Google Workspace Anda harus membuat dua sumber identitas dan memberikan ID-nya kepada Anda:

    • satu untuk pengguna dan grup Office 365
    • satu untuk grup SharePoint

    Admin juga harus mendapatkan ID pelanggan Google Workspace organisasi dan memberikannya kepada Anda.

    Pelajari cara mendapatkan nilai tersebut di Memetakan identitas pengguna di Cloud Search.

  4. Siapkan akun pengguna untuk konektor yang memiliki hak istimewa Administrator Koleksi Situs SharePoint Online.

  5. Jika konektor menampilkan hasil berdasarkan ACL (hasilnya tidak terbuka untuk publik), buat kredensial untuk membaca pengguna dan grup dari akun Office 365 Anda. Ikuti petunjuk Microsoft untuk membuat aplikasi Azure Active Directory. Saat Anda menyiapkan aplikasi:

    1. Beri nama aplikasi dengan nama deskriptif, seperti "gcs-o365-identity-connector".
    2. Tambahkan izin. Aplikasi membutuhkan "Group.Read.All" dan "User.Read.All".
    3. Catat informasi berikut untuk digunakan dalam konfigurasi konektor:
      • ID Aplikasi
      • Tenant
      • Rahasia Klien

Langkah 1. Menginstal software konektor SharePoint Online

  1. Clone repositori konektor dari GitHub.

    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. Lihat versi konektor yang diinginkan:

    $ git checkout tags/v1-0.0.3
  3. Buat konektor.

    $ mvn package

    Untuk melewati pengujian saat Anda membuat konektor, jalankan mvn package -DskipTests, bukan mvn package.

  4. Salin file zip konektor ke direktori penginstalan lokal Anda:

    $ cp target/google-cloudsearch-sharepoint-connector-v1-0.0.3.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-sharepoint-connector-v1-0.0.3.zip
    $ cd google-cloudsearch-sharepoint-connector-v1-0.0.3

Langkah 2. Membuat file konfigurasi konektor Online SharePoint

  1. Di direktori yang sama dengan penginstalan konektor, buat file baru dan beri nama sharepoint-online-connector.config. Jika Anda berencana untuk menjalankan banyak instance konektor, tambahkan detail lainnya pada nama untuk membedakannya.

  2. Tambahkan parameter sebagai key-value pair ke konten file, seperti dalam contoh berikut:

    ### SharePoint Online connector configuration ###
    
    # Required parameters for data source access
    api.sourceId=08ef8becd116faa4546b8ca2c84b2879
    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
    
    # Optional SharePoint List Item metadata parameters
    contentTemplate.sharepointItem.title=Title
    contentTemplate.sharepointItem.unmappedColumnsMode=APPEND
    

    Untuk mengetahui deskripsi mendetail dari setiap parameter, buka referensi parameter konfigurasi.

  3. (Opsional) Konfigurasikan parameter konektor tambahan, sesuai kebutuhan. Untuk mengetahui detailnya, buka Parameter konektor yang disediakan Google.

Langkah 3. Menyiapkan logging untuk konektor SharePoint Online

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

  2. Buat file berenkode Latin-1 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
    

Langkah 4. Mengonfigurasi konektor identitas SharePoint Online

Langkah ini diperlukan untuk menerapkan ACL berbasis identitas SharePoint Online ke hasil penelusuran. Jika Anda menyiapkan konektor dengan ACL publik, Anda dapat melewati langkah ini.

  1. Di direktori yang sama dengan penginstalan konektor SharePoint Online, buat file baru dan beri nama sharepoint-online-identity-connector.config.

  2. Tambahkan parameter sebagai key-value pair ke konten file, seperti dalam contoh berikut:

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

    Nilainya hampir sama dengan konektor SharePoint Online, tetapi parameternya adalah api.customerId, bukan api.sourceId. Nilai api.customerId adalah ID pelanggan yang Anda dapatkan dari admin Google Workspace.

Langkah 5. Menginstal konektor Identity Office 365

Langkah ini diperlukan untuk menerapkan ACL berbasis identitas SharePoint Online ke hasil penelusuran. Jika Anda menyiapkan konektor dengan ACL publik, Anda dapat melewati langkah ini.

  1. Clone repositori konektor dari GitHub.

    $ git clone https://github.com/google-cloudsearch/office-365-connector.git
    $ cd office-365-connector
  2. Lihat versi konektor yang diinginkan:

    $ git checkout tags/v1-0.0.3
  3. Buat konektor.

    $ mvn package

    Untuk melewati pengujian saat Anda membuat konektor, jalankan mvn package -DskipTests, bukan mvn package.

  4. Salin file zip konektor ke direktori penginstalan lokal Anda:

    $ cp target/google-cloudsearch-office-365-connector-v1-0.0.3.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-office-365-connector-v1-0.0.3.zip
    $ cd google-cloudsearch-office-365-connector-v1-0.0.3

Langkah 6. Mengonfigurasi konektor Identity Office 365 dan menyiapkan logging

  1. Di direktori yang sama dengan penginstalan konektor identitas, buat file baru dan beri nama o365-identity-connector.config.

  2. Tambahkan parameter sebagai key-value pair ke konten file, seperti dalam contoh berikut. Catatan: Semua parameter wajib diisi.

    ### Office 365 Identity connector configuration ###
    api.identitySourceId=12345abcde api.customerId=abcde12345 o365.clientId=a63c6eb3-29e7-486 o365.tenant=185ef9ed-29e7-486 o365.clientSecret=raHJN15vRLBKs

    Untuk mengetahui deskripsi mendetail dari setiap parameter, buka Referensi konfigurasi konektor Identity Office 365.

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

  4. 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 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 SharePoint Online

Pada langkah berikut, Anda harus memetakan akun utama di Office 365 dan koleksi situs SharePoint ke identitas di layanan Google Cloud Identity. Sinkronisasi ini dilakukan dengan konektor Identity Office 365 dan konektor identitas SharePoint Online.

Setelah konektor Office 365 menyinkronkan pengguna dan grup, jalankan konektor identitas SharePoint Online, untuk menyinkronkan grup koleksi situs SharePoint. Kemudian, Anda akan menjalankan konektor SharePoint Online untuk mengindeks dan menayangkan hasil ke pengguna Cloud Search.

  1. Jalankan konektor identitas 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. Jalankan konektor identitas SharePoint Online:

    $ java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-v1-0.0.3.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector -Dconfig=sharepoint-online-identity-connector.config
  3. Jalankan konektor 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

Referensi parameter konfigurasi

Akses sumber data

Setelan Parameter
ID sumber data api.sourceId=1234567890abcdef

Wajib diisi. ID sumber data Google Cloud Search yang disiapkan oleh administrator Google Workspace.

Lokasi ke file kunci pribadi akun layanan api.serviceAccountPrivateKeyFile=PrivateKey.json

Wajib diisi. 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 diisi. Jika nama domain tidak sepenuhnya memenuhi syarat, tetapkan penggantian DNS pada host konektor.

Mode Khusus Kumpulan Situs sharepoint.siteCollectionOnly=true

Wajib diisi. Untuk SharePoint Online, tetapkan nilai true.

Nama pengguna SharePoint sharepoint.username=username

Wajib diisi. Nama pengguna untuk akun yang digunakan untuk mengakses SharePoint Online.

Sandi SharePoint sharepoint.password=user_password

Wajib diisi. Sandi untuk akun yang digunakan untuk mengakses SharePoint Online.

Mode Autentikasi sharepoint.formsAuthenticationMode=LIVE

Wajib diisi. Untuk SharePoint Online, nilainya selalu `LIVE`.

Jenis Penerapan sharepoint.deploymentType=ONLINE

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

Pemetaan Identitas SharePoint

Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef

Wajib diisi. ID sumber identitas Cloud Search untuk sumber identitas grup SharePoint.

Sumber Identitas Referensi api.referenceIdentitySources=defaultIdentitySource

Wajib diisi. Untuk online SharePoint point, nilainya selalu `defaultIdentitySource`.

ID Sumber Identitas Referensi api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

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

Pembuatan konten HTML

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

Kolom SharePoint untuk digunakan sebagai judul template HTML untuk HTML yang dibuat.

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, hasilnya 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 dengan kualitas 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 yang tidak ditetapkan dengan tingkat kualitas (tinggi, sedang, atau rendah).
  • IGNORE—Konektor membuat konten HTML hanya dengan kolom yang dipetakan.

Konfigurasi konektor Identity Office 365

Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef

Wajib diisi. ID sumber identitas Office 365. Nilai ini harus cocok dengan nilai `api.referenceIdentitySource.defaultIdentitySource.id` di konfigurasi konektor SharePoint Online.

ID Pelanggan Google api.customerId=c1b1d1e1

Wajib diisi. ID pelanggan Google Workspace organisasi Anda.

ID Aplikasi Office 365 o365.clientId=a63c6eb3-29e7-486

Wajib diisi. ID aplikasi dari penyiapan aplikasi Office 365.

Tenant Office 365 o365.tenant=185ef9ed-29e7-486

Wajib diisi. tenant untuk akun Office 365 Anda (aplikasi Azure Activity Directory Anda)

Rahasia klien Office 365 o365.clientSecret=raHJN15vRLBKs

Wajib diisi. Rahasia kredensial dari penyiapan Aplikasi Office 365