Melakukan Deployment Konektor Microsoft SharePoint On-Prem

Anda dapat menyiapkan Google Cloud Search untuk menampilkan hasil dari konten lokal SharePoint tambahan milik organisasi Anda selain konten Google Workspace Anda. Anda menggunakan konektor Google Cloud Search SharePoint On-Prem dan mengonfigurasinya untuk mengakses sumber data SharePoint tertentu.

Pertimbangan penting

Mengikuti setelan SharePoint

Konektor Cloud Search SharePoint On-Prem selalu mengikuti setelan Visibilitas Penelusuran di SharePoint, yang tidak dapat diganti. Untuk draf dokumen, izin pada akun pengguna (yang digunakan konektor untuk mengakses SharePoint Online) mengontrol dokumen draf yang diindeks dan ditampilkan. Jika akun hanya memiliki izin "Full Read", konektor akan memenuhi "Draf visibilitas item" di SharePoint.

Anda juga dapat mengonfigurasi konektor untuk membatasi hasil berdasarkan akses akun pengguna. Anda dapat menggunakan akun utama Google dan akun utama eksternal untuk menentukan ACL. Untuk menerapkan pemangkasan keamanan pada konten SharePoint, sinkronkan identitas eksternal berikut dengan Direktori Google:

  • Pengguna Direktori Aktif
  • Grup Direktori Aktif
  • Grup Lokal SharePoint (dengan pengguna dan grup Direktori Aktif sebagai anggota)

Untuk menyinkronkan pengguna dan grup AD, Anda dapat menggunakan Google Cloud Directory Sync, yang mengaktifkan grup dengan pemetaan identitas. Untuk menyinkronkan grup lokal SharePoint, Anda harus menggunakan SharePoint Identity Connector.

Konektor juga perlu melakukan pencarian dengan AD untuk mengambil informasi tambahan guna menyinkronkan akun utama. Misalnya, pencarian dengan AD memungkinkan konektor melakukan hal berikut:

  • Petakan SID untuk grup domain ke sAMAccountName yang sesuai.
  • Petakan sAMAccountName pengguna ke alamat email untuk keanggotaan grup lokal SharePoint.

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.

  • Untuk memetakan nama properti SharePoint ke definisi properti, konektor akan menormalkan nama properti dengan mendekode karakter berenkode hex dan menghapus "ows_" awalan, lalu mengecualikan karakter yang tidak didukung (semua karakter kecuali A-Z, a-z, dan 0-9 sebagai karakter yang valid).

Penanganan pesan Microsoft Outlook

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

Konfigurasi multi-tenant

Jika SharePoint merupakan deployment multi-tenant, tempat beberapa situs pelanggan dihosting di aplikasi Web yang sama, Anda harus mengonfigurasi mode pengumpulan situs di file konfigurasi. Dalam deployment multi-tenant, Anda hanya mendapatkan izin untuk pengumpulan situs dan tidak bisa mendapatkan izin Full Read, seperti yang diwajibkan oleh konektor SharePoint On-Prem.

Untuk mengaktifkan mode pengumpulan situs:

  • Berikan izin administrator koleksi situs kepada akun pengguna konektor.
  • Tetapkan sharepoint.server di file konfigurasi konektor Anda ke URL koleksi situs, seperti http://sharepoint.example.com/sites/sitecollection. URL tidak perlu menggunakan kasus yang sama persis seperti di SharePoint.
  • Tetapkan sharepoint.siteCollectionOnly di file konfigurasi konektor Anda ke true.

Jika Anda memiliki beberapa koleksi situs untuk diindeks di lingkungan multi-tenant, Anda perlu mengonfigurasi satu instance konektor untuk setiap koleksi situs.

Batasan umum konektor

  • Waktu yang diperlukan konektor untuk mendeteksi perubahan pada item dalam database akan meningkat dengan jumlah database yang dipantau konektor.
  • Konsumsi memori meningkat dengan jumlah pengguna dan grup unik yang Anda gunakan dalam ACL untuk setiap koleksi situs.
  • Anda dapat mengonfigurasi konektor dengan identitas hanya dari satu Domain Active Directory.
  • Beberapa akun utama Active Directory dan Windows yang umum, seperti Everyone, BUILTIN\Users, dan All Authenticated Users, tidak didukung.
  • 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)
Software
  • Server SharePoint
    • Server SharePoint 2016
    • Server SharePoint 2013
  • Java JRE 1.8 yang diinstal di komputer yang akan menjalankan konektor Google Cloud Search SharePoint On-Prem
Autentikasi
  • NTLM
  • Kerberos
  • HTTP Dasar
  • IKLAN

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:

    • Sumber identitas untuk menyinkronkan pengguna dan grup Direktori Aktif.
    • Sumber identitas untuk grup Lokal 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 izin Full Read ke Aplikasi Web SharePoint dalam kebijakan pengguna.

  5. Jika Aplikasi Web SharePoint tidak memiliki koleksi situs root, buat koleksi.

  6. Jika ada koleksi situs yang terkunci, login ke server SharePoint dengan akun yang memiliki hak istimewa Admin dan jalankan skrip PrepareWriteLockedSites.ps1.

  7. Untuk mendapatkan metrik sumber data sebagai dasar untuk konfigurasi konektor Anda, login ke server SharePoint dengan akun yang memiliki hak istimewa administrasi pertanian dan jalankan diagnose_sp.ps1.

    Outputnya melaporkan jumlah aplikasi web, dokumen, dan keanggotaan grup pengguna. Gunakan informasi ini untuk memperkirakan jumlah instance konektor yang Anda butuhkan, persyaratan memori, dan jumlah dokumen.

Langkah 1. Instal software konektor Google Cloud Search SharePoint On-Prem.

  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/latest_version

    Di mana: latest_version = nilai seperti v1-0.0.5

  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-latest_version.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-sharepoint-connector-latest_version.zip
    $ cd google-cloudsearch-sharepoint-connector-latest_version

Langkah 2. Membuat file konfigurasi konektor SharePoint On-Prem

  1. Buat direktori pada direktori yang sama dengan penginstalan konektor. Google merekomendasikan agar Anda memberi nama file connector-config.properties sehingga tidak ada parameter command line tambahan yang diperlukan untuk menjalankan konektor. Jika Anda berencana untuk menjalankan banyak instance konektor, tambahkan detail ke nama untuk membedakannya.

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

    ### Sharepoint On-Prem Connector configuration ###
    
    # Required parameters for data source access
    api.sourceId=08ef8becd116faa4546b8ca2c84b2879
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9
    
    # Required parameters for SharePoint on-premises access
    sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
    sharepoint.siteCollectionOnly=true
    sharepoint.username=contoso\\admin
    sharepoint.password=pa$sw0rd
    sharepoint.stripDomainInUserPrincipals=true
    
    # Required parameters for AD lookup
    adLookup.host=dc.contoso.com
    adLookup.username=contoso\\admin
    adLookup.password=pa$sw0rd
    api.referenceIdentitySources=CONTOSO,contoso
    api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
    api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa
    
    # Optional parameters for schema mapping
    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. Untuk HTTPS, tambahkan SharePoint sebagai host tepercaya

Jika SharePoint dikonfigurasi untuk menggunakan HTTPS, dapatkan sertifikat SharePoint untuk menambahkannya sebagai host tepercaya untuk konektor.

  1. Di komputer yang akan menjalankan konektor, buka browser, lalu buka SharePoint.

  2. Di halaman peringatan yang terbuka, klik Saya Memahami Risiko dan Tambahkan Pengecualian. Halaman tersebut akan menampilkan pesan seperti "Koneksi Ini Tidak Tepercaya" karena sertifikat tersebut ditandatangani sendiri dan tidak ditandatangani oleh Certificate Authority tepercaya.

  3. Klik tombol View setelah tersedia.

  4. Buka tab Details dan klik Export.

  5. Simpan sertifikat di direktori konektor dengan nama sharepoint.crt.

  6. Klik Close lalu Cancel untuk menutup jendela.

  7. Buka command prompt, lalu masukkan perintah berikut:

    $ keytool -importcert -keystore cacerts.jks -storepass changeit -file sharepoint.crt -alias sharepoint

    Saat diminta "Percayai sertifikat inişquot;, jawab ya.

Langkah 4. Siapkan logging

  1. Dalam direktori yang berisi biner konektor, buat folder bernama logs.

  2. Dalam direktori yang sama (bukan logs), buat file berenkode Latin1 yang bernama logging.properties.

  3. Tambahkan teks berikut ke 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
    

Langkah 5. Mengonfigurasi konektor identitas SharePoint On-Prem

Langkah ini diperlukan untuk menerapkan ACL berbasis identitas SharePoint On-Prem 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 dan beri nama sharepoint-onprem-identity-connector.config.

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

    ### SharePoint On-prem identity connector configuration ###
    
    # Required parameters for data source access
    api.customerId=C05d3djk8
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9
    
    # Required parameters for SharePoint access
    sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
    sharepoint.siteCollectionOnly=true
    sharepoint.username=contoso\\admin
    sharepoint.password=pa$sw0rd
    sharepoint.stripDomainInUserPrincipals=true
    
    # Required parameters for AD lookup
    adLookup.host=dc.contoso.com
    adLookup.username=contoso\\admin
    adLookup.password=pa$sw0rd
    api.referenceIdentitySources=CONTOSO,contoso
    api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
    api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa
    

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

Langkah 6. Meluncurkan konektor SharePoint On-Prem

Pada langkah berikut, Anda memetakan akun utama di Active Directory lokal dan koleksi situs SharePoint ke identitas di layanan Google Cloud Identity. Sinkronisasi ini dilakukan dengan Google Cloud Directory Sync (GCDS) dan konektor identitas SharePoint On-Prem.

Setelah GCDS menyinkronkan pengguna dan grup, untuk menyinkronkan grup koleksi situs SharePoint, jalankan konektor identitas SharePoint On-Prem. Terakhir, jalankan konektor SharePoing On-Prem untuk mengindeks dan menayangkan hasil kepada pengguna Cloud Search Anda.

  1. Jika Anda belum melakukannya, konfigurasikan dan jalankan GCDS. Pastikan untuk mengaktifkan grup dengan pemetaan identitas.

  2. Jalankan konektor identitas SharePoint On-Prem:

    $ java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-version.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector -Dconfig=sharepoint-onprem-identity-connector.config
  3. Jalankan konektor SharePoint On-Prem. Gunakan sintaksis perintah untuk keamanan situs SharePoint Anda:

    • HTTP (host tepercaya tidak diperlukan):

      $ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar
    • HTTPS (tambahkan SharePoint sebagai host tepercaya):

      $ java -Djavax.net.ssl.trustStore=cacerts.jks -Djavax.net.ssl.trustStoreType=jks -Djavax.net.ssl.trustStorePassword=changeit -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar

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 lokal SharePoint

Setelan Parameter
URL server SharePoint sharepoint.server=http://yoursharepoint.example.com/

Wajib diisi. URL server SharePoint sebagai nama host yang sepenuhnya memenuhi syarat, seperti http://yoursharepoint.example.com/. Jika nama host tidak sepenuhnya memenuhi syarat, Anda harus menetapkan penggantian DNS pada host konektor.

Nama pengguna SharePoint sharepoint.username=YOURDOMAIN\\ConnectorUser

Wajib diisi saat Anda menjalankan konektor di Linux atau di komputer Windows yang bukan bagian dari domain SharePoint Server AD.

Sandi SharePoint sharepoint.password=user_password

Wajib diisi saat Anda menjalankan konektor di Linux atau di komputer Windows yang bukan bagian dari domain SharePoint Server AD.

Gunakan Autentikasi Live untuk terhubung ke SharePoint sharepoint.username=AdaptorUser Live Authentication Id

sharepoint.password uS3R_passWoRD

sharepoint.formsAuthenticationMode=LIVE

Gunakan Autentikasi ADFS untuk terhubung ke SharePoint sharepoint.username=AdaptorUser@yourdomain.com

sharepoint.password=uS3R_passWoRD

sharepoint.sts.endpoint=https://adfs.example.com/adfs/services/trust/2005/usernamemixed

sharepoint.sts.realm=urn:myserver:sharepoint atau https://yoursharepoint.example.com/_trust

sharepoint.formsAuthenticationMode=ADFS

Pengindeksan koleksi situs

Setelan Parameter
Jenis indeks sharepoint.siteCollectionOnly=boolean

Opsional, kecuali untuk deployment SharePoint multi-tenant (pelajari lebih lanjut). Tetapkan ke true agar memiliki indeks indeks sharepoint.server sebagai koleksi situs, bukan sebagai server virtual. Defaultnya adalah null (terdeteksi otomatis).

Pemetaan Identitas SharePoint

Setelan Parameter
ID Sumber Identitas api.identitySourceId=1234567890abcdef

Wajib diisi. ID sumber identitas untuk menyinkronkan Grup Lokal SharePoint.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=CONTOSO,contoso

Daftar sumber identitas referensi yang dipisahkan koma untuk akun utama direktori aktif. Nilai cocok dengan nama NETBIOS Active Directory dari referensi utama direktori aktif.

ID Sumber Identitas Referensi api.referenceIdentitySource.DOMAIN.id=identity-source-id

Wajib diisi. ID Sumber Identitas untuk menyinkronkan akun utama Active Directory.

Pencarian Direktori Aktif

Setelan Parameter
Host Direktori Aktif adLookup.host=host

Wajib diisi. Hostname direktori aktif, seperti dc.contoso.com, atau alamat IP.

Port pencarian Direktori Aktif adLookup.port=port

Opsional. Port defaultnya adalah 389. Gunakan 686 untuk SSL.

Metode pencarian Direktori Aktif adLookup.method=value

Opsional. Defaultnya adalah `standard`. Untuk koneksi HTTPS, tetapkan ke `ssl`.

Pengguna pencarian Direktori Aktif adLookup.username=CONTOSO\user1

Wajib diisi. Pengguna diizinkan untuk melakukan pencarian direktori aktif.

Sandi pencarian Direktori Aktif adLookup.password=password123

Wajib diisi. Sandi untuk pengguna yang ditentukan oleh adLookup.user.

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