Microsoft SharePoint On-Prem Bağlayıcısı'nı Dağıtma

Google Cloud Search'ü, Google Workspace içeriğinize ek olarak kuruluşunuzun SharePoint şirket içi içeriğinden sonuçlar döndürecek şekilde ayarlayabilirsiniz. Google Cloud Search SharePoint On-Prem bağlayıcısını kullanır ve belirli bir SharePoint veri kaynağına erişecek şekilde yapılandırırsınız.

Dikkat edilmesi gerekenler

Onaylanmış SharePoint ayarları

Cloud Search SharePoint On-Prem bağlayıcısı, SharePoint'te her zaman geçersiz kılınamayan Arama Görünürlüğü ayarını dikkate alır. Taslak dokümanlarda, kullanıcı hesabındaki (bağlayıcının SharePoint Online'a erişmek için kullandığı) izinler dizine eklenecek ve döndürülecek taslak dokümanları kontrol eder. Hesap yalnızca "Tam Okuma" izinlerine sahipse bağlayıcı, SharePoint'te "Taslak öğe görünürlüğü" ayarlarını dikkate alır.

Bağlayıcıyı, sonuçları kullanıcı hesabı erişimine göre sınırlayacak şekilde de yapılandırabilirsiniz. EKL'leri tanımlamak için Google ana hesaplarını ve harici ana hesapları kullanabilirsiniz. SharePoint içeriğine güvenlik kırpma uygulamak için aşağıdaki harici kimlikleri Google Dizin ile senkronize edin:

  • Active Directory Kullanıcıları
  • Active Directory Grupları
  • SharePoint Yerel Grupları (üye olarak Active Directory kullanıcıları ve grupları ile)

AD kullanıcılarını ve gruplarını senkronize etmek için, kimlik eşlemesi yapılmış grupları etkinleştirmek üzere Google Cloud Directory Sync'i kullanabilirsiniz. SharePoint yerel gruplarını senkronize etmek için SharePoint Identity Bağlayıcısı'nı kullanırsınız.

Bağlayıcının, ana hesapları senkronize etmek amacıyla ek bilgileri getirmek için AD ile arama da yapması gerekir. Örneğin, AD ile arama, bağlayıcının aşağıdakileri yapmasına olanak tanır:

  • Alan grubunun SID'sini ilgili sAMAccountName ile eşleyin.
  • sAMAccountName adlı bir kullanıcıyı SharePoint yerel grup üyelikleri için e-posta adresiyle eşleyin.

Arama optimizasyonu

Bağlayıcıyı daha alakalı arama sonuçları döndürecek şekilde yapılandırarak kullanıcılarınızın deneyimini iyileştirebilirsiniz.

API'yi kullanmak için SharePoint Online bağlayıcı yapılandırma dosyasında HTML oluşturma parametrelerinin değerlerini ayarlayın. Bu parametreler, hangi alanların eşleşmeler üzerinde daha yüksek veya daha düşük etkiye sahip olduğunu belirlemenize olanak tanır.

Şema oluşturmak için Şema oluşturma ve kaydetme başlıklı makaledeki talimatları uygulayın. Bir şema ayarladığınızda:

  • Bağlayıcı, SharePoint içerik türlerinin adlarını karşılık gelen nesne tanımlarıyla eşlemek için içerik türü adlarını desteklenmeyen karakterleri hariç tutarak normalleştirir. Cloud Search API, nesne tanımları için yalnızca A-Z, a-z ve 0-9 karakterlerini geçerli karakter olarak destekler. Örneğin, "Duyurular" içerik türü "Duyurular" nesne tanımıyla eşleşir. "News Article" içerik türü, "NewsArticle" ile eşleşir (boşluksuz).

  • Bağlayıcı, bir nesne tanımını nesne tanımıyla eşleştiremediğinde bağlayıcı yedek nesne türünü (itemMetadata.objectType) kullanır. Meta veri yapılandırma parametreleri hakkında daha fazla bilgi edinin.

  • SharePoint özellik adlarını özellik tanımlarıyla eşlemek için bağlayıcı, onaltılık olarak kodlanmış karakterlerin kodunu çözerek ve "ows_" öneklerini kaldırıp desteklenmeyen karakterleri (A-Z, a-z ve 0-9 dışındaki tüm karakterler geçerli karakter olarak) hariç tutarak özellik adlarını normalleştirir.

Microsoft Outlook ileti işleme

Bağlayıcı, içeriği dizine eklerken Microsoft Outlook .msg dosyalarıyla karşılaştığında, dosyaların medya türünü geçersiz kılar ve bunları application/vnd.ms-outlook. olarak dizine ekler

Çok kiracılı yapılandırmaları

SharePoint'iniz, birden fazla müşteri sitesinin aynı web uygulamasında barındırıldığı çok kiracılı bir dağıtımsa yapılandırma dosyasında site toplama modunu yapılandırmanız gerekir. Çok kiracılı dağıtımlarda, yalnızca site koleksiyonunuz için izinlere sahip olur ve SharePoint On-Prem bağlayıcısının gerektirdiği şekilde Tam Okuma izinlerini alamazsınız.

Site toplama modunu etkinleştirmek için:

  • Bağlayıcı kullanıcı hesabına site toplama yöneticisi izinleri verin.
  • Bağlayıcı yapılandırma dosyanızda sharepoint.server öğesini http://sharepoint.example.com/sites/sitecollection gibi site koleksiyonu URL'sine ayarlayın. URL'nin SharePoint'teki büyük/küçük harf aynısını kullanması gerekmez.
  • Bağlayıcı yapılandırma dosyanızda sharepoint.siteCollectionOnly değerini true olarak ayarlayın.

Çok kiracılı bir ortamda dizine eklenecek birden fazla site koleksiyonunuz varsa her site koleksiyonu için bir bağlayıcı örneği yapılandırmanız gerekir.

Bilinen bağlayıcı sınırlamaları

  • Bağlayıcının izlediği veritabanlarının sayısıyla birlikte, bağlayıcının veritabanlarındaki öğelerde yapılan değişiklikleri algılaması için gereken süre artar.
  • Bellek tüketimi, her site koleksiyonu için EKL'lerde kullandığınız benzersiz kullanıcı ve grup sayısıyla birlikte artar.
  • Bağlayıcıyı yalnızca bir Active Directory alanından kimliklerle yapılandırabilirsiniz.
  • Everyone, BUILTIN\Users ve All Authenticated Users gibi bazı yaygın Active Directory ve Windows ana hesapları desteklenmez.
  • Silme bildirimleri anlık değildir ve bir bağlayıcının, kullanıcının kaynak depodan içerik sildiğini tanıması 4 saatten fazla sürebilir.

Sistem gereksinimleri

Sistem gereksinimleri
İşletim sistemi
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 bit)
Yazılım
  • SharePoint sunucusu
    • SharePoint Server 2016
    • SharePoint Server 2013
  • Google Cloud Search SharePoint On-Prem bağlayıcısını çalıştıracak bilgisayarda Java JRE 1.8 yüklü
Kimlik doğrulama
  • NTLM
  • Kerberos
  • Temel HTTP
  • ADFS

Bağlayıcıyı dağıtma

Ön koşullar

  1. Hizmet hesabı kimliğinizi içeren bir Google Workspace özel anahtarı oluşturun. Özel anahtarı nasıl alacağınızı öğrenmek için Google Cloud Search API'ye erişimi yapılandırma başlıklı makaleyi inceleyin.

  2. Google Workspace yöneticinizin arama yapmak için bir veri kaynağı eklemesi gerekir. Veri kaynağı kimliğini kaydedin.

  3. Bağlayıcı, EKL'lere dayalı sonuçlar döndürürse (sonuçlar herkese açık değildir) Google Workspace yöneticinizin iki kimlik kaynağı oluşturması ve size kimliklerini sağlaması gerekir:

    • Active Directory kullanıcılarını ve gruplarını senkronize etmek için bir kimlik kaynağı.
    • SharePoint yerel grupları için kimlik kaynağı

    Ayrıca yöneticinin kuruluşunuzun Google Workspace müşteri kimliğini de alıp size vermesi gerekir.

    Bu değerleri nasıl edineceğinizi Cloud Search'te kullanıcı kimliklerini eşleme bölümünde öğrenebilirsiniz.

  4. Kullanıcı politikasında SharePoint Web Uygulaması için Tam Okuma izinlerine sahip bağlayıcı için bir kullanıcı hesabı oluşturun.

  5. SharePoint Web Uygulamasının kök site koleksiyonu yoksa bir koleksiyon oluşturun.

  6. Site koleksiyonlarının yazma kilidi varsa, SharePoint sunucusunda Yönetici ayrıcalıklarına sahip bir hesapla oturum açın ve PrepareWriteLockedSites.ps1 komut dosyasını çalıştırın.

  7. Bağlayıcı yapılandırmanıza bilgi verecek veri kaynağı metriklerini almak için SharePoint sunucusunda çiftlik yönetimi ayrıcalıklarına sahip bir hesapla oturum açın ve diagnose_sp.ps1 komutunu çalıştırın.

    Bu çıkış; web uygulamalarının, dokümanların ve kullanıcı grubu üyeliklerinin sayısını bildirir. Kaç bağlayıcı örneğine ihtiyacınız olduğunu, bellek gereksinimlerini ve belge sayısını tahmin etmek için bu bilgilerden yararlanabilirsiniz.

1. Adım: Google Cloud Search SharePoint On-Prem bağlayıcı yazılımını yükleyin.

  1. GitHub'dan bağlayıcı deposunu klonlayın.

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

  2. Bağlayıcının istediğiniz sürümünü kontrol edin:

    $ git checkout tags/latest_version

    Bu durumda: latest_version = v1-0.0.5 gibi bir değer

  3. Bağlayıcıyı oluşturun.

    $ mvn package

    Bağlayıcıyı oluştururken testleri atlamak için mvn package yerine mvn package -DskipTests komutunu çalıştırın.

  4. Bağlayıcı zip dosyasını yerel yükleme dizininize kopyalayın:

    $ 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

2. adım: SharePoint On-Prem bağlayıcı yapılandırma dosyasını oluşturma

  1. Bağlayıcı kurulumuyla aynı dizinde bir dosya oluşturun. Google, bağlayıcıyı çalıştırmak için ek komut satırı parametreleri gerekmeyecek şekilde dosyayı connector-config.properties olarak adlandırmanızı önerir. Çok sayıda bağlayıcı örneği çalıştırmayı planlıyorsanız, ayırt etmek için ada ayrıntılar ekleyin.

  2. Parametreleri, aşağıdaki örnekte gösterildiği gibi, dosya içeriğine anahtar/değer çiftleri olarak ekleyin:

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

    Her parametreyle ilgili ayrıntılı açıklamalar için yapılandırma parametreleri referansı sayfasına gidin.

  3. (İsteğe bağlı) Ek bağlayıcı parametrelerini gerektiği şekilde yapılandırın. Ayrıntılar için Google'ın sağladığı bağlayıcı parametreleri bölümüne gidin.

3. adım: HTTPS için SharePoint'i güvenilir ana makine olarak ekleyin

SharePoint HTTPS kullanacak şekilde yapılandırıldıysa, bağlayıcı için güvenilir ana makine olarak eklemek üzere bir SharePoint sertifikası alın.

  1. Bağlayıcıyı çalıştıracak bilgisayarda bir tarayıcı açıp SharePoint'e gidin.

  2. Açılan uyarı sayfasında Riskleri Anlıyorum ve İstisna Ekle'yi tıklayın. Sertifika kendinden imzalı olduğu ve güvenilir bir Sertifika Yetkilisi tarafından imzalanmadığı için sayfada "Bu Bağlantı Güvenilmez" gibi bir mesaj gösterilir.

  3. Görüntüle düğmesi kullanılabilir olduğunda bu düğmeyi tıklayın.

  4. Ayrıntılar sekmesine gidin ve Dışa aktar'ı tıklayın.

  5. Sertifikayı sharepoint.crt adıyla bağlayıcı dizinine kaydedin.

  6. Pencereleri kapatmak için Kapat'ı, ardından İptal'i tıklayın.

  7. Bir komut istemi açın ve aşağıdaki komutu girin:

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

    "Bu sertifikaya güvenilsin mi?" sorusu sorulduğunda evet yanıtını verin.

4. Adım: Günlük kaydını ayarlama

  1. Bağlayıcı ikili programını içeren dizinde logs adlı bir klasör oluşturun.

  2. Aynı dizinde (logs değil), logging.properties adında Latin1 kodlu bir dosya oluşturun.

  3. Şu metni logging.properties içine ekleyin:

    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

5. Adım: SharePoint On-Prem kimlik bağlayıcısını yapılandırma

Bu adım, arama sonuçlarına SharePoint On-Prem kimliğe dayalı EKL'ler uygulamak için gereklidir. Bağlayıcıyı herkese açık EKL'lerle ayarlarsanız bu adımı atlayabilirsiniz.

  1. SharePoint Online bağlayıcısının yüklendiği dizinde bir dosya oluşturun ve dosyayı sharepoint-onprem-identity-connector.config olarak adlandırın.

  2. Parametreleri, aşağıdaki örnekte gösterildiği gibi, dosya içeriğine anahtar/değer çiftleri olarak ekleyin:

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

    Değerler, api.sourceId yerine api.customerId parametresi olması haricinde SharePoint On-Prem bağlayıcısıyla hemen hemen aynıdır. api.customerId değeri, Google Workspace yöneticinizden aldığınız müşteri kimliğidir.

6. Adım: SharePoint On-Prem bağlayıcısını başlatma

Aşağıdaki adımlarda, hem şirket içi Active Directory'deki hem de SharePoint sitesi koleksiyonundaki ana hesapları Cloud Identity hizmetindeki kimliklerle eşleyeceksiniz. Bu senkronizasyon, Google Cloud Directory Sync (GCDS) ve SharePoint On-Prem kimlik bağlayıcısı ile yapılır.

GCDS kullanıcıları ve grupları senkronize ettikten sonra, SharePoint sitesi toplama gruplarını senkronize etmek için SharePoint On-Prem kimlik bağlayıcısını çalıştırın. Son olarak, sonuçları Cloud Search kullanıcılarınıza dizine eklemek ve sunmak için SharePoing On-Prem bağlayıcısını çalıştırın.

  1. Henüz yapmadıysanız GCDS'yi yapılandırın ve çalıştırın. Kimlik eşlemesi yapılmış grupları etkinleştirdiğinizden emin olun.

  2. SharePoint On-Prem kimlik bağlayıcısını çalıştırın:

    $ 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. SharePoint On-Prem bağlayıcısını çalıştırın. SharePoint site güvenliğiniz için komut söz dizimini kullanın:

    • HTTP (güvenilir ana makine gerekmez):

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

    • HTTPS (SharePoint'i güvenilir ana makine olarak ekleyin):

      $ 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

Yapılandırma parametreleri referansı

Veri kaynağı erişimi

Yer Parametre
Veri kaynağı kimliği api.sourceId=1234567890abcdef

Zorunlu. Google Workspace yöneticisi tarafından oluşturulan Google Cloud Search veri kaynağı kimliği.
Hizmet hesabı özel anahtar dosyasının yolu api.serviceAccountPrivateKeyFile=PrivateKey.json

Zorunlu. Google Cloud Search hizmet hesabı anahtar dosyasının yolu.

SharePoint şirket içi erişimi

Yer Parametre
SharePoint sunucu URL'si sharepoint.server=http://yoursharepoint.example.com/

Zorunlu. Tam nitelikli bir ana bilgisayar adı olarak SharePoint sunucusunun URL'si (ör. http://paylaşım noktanız.example.com/). Ana makine adı tam nitelikli değilse bağlayıcı ana bilgisayarında DNS geçersiz kılmayı ayarlamanız gerekir.
SharePoint kullanıcı adı sharepoint.username=YOURDOMAIN\\ConnectorUser

Bağlayıcıyı Linux'ta veya SharePoint Server AD alanının parçası olmayan bir Windows makinesinde çalıştırdığınızda gerekir.
SharePoint şifresi sharepoint.password=user_password

Bağlayıcıyı Linux'ta veya SharePoint Server AD alanının parçası olmayan bir Windows makinesinde çalıştırdığınızda gerekir.
SharePoint'e bağlanmak için canlı kimlik doğrulamayı kullanma sharepoint.username=AdaptorUser Live Authentication Id

sharepoint.password uS3R_passWoRD

sharepoint.formsAuthenticationMode=LIVE
SharePoint'e bağlanmak için ADFS Kimlik Doğrulaması kullanma 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 veya https://yoursharepoint.example.com/_trust

sharepoint.formsAuthenticationMode=ADFS

Site koleksiyonu dizine ekleme

Yer Parametre
Dizin türü sharepoint.siteCollectionOnly=boolean

Çok kiracılı SharePoint dağıtımları hariç isteğe bağlıdır (daha fazla bilgi). sharepoint.server bağlayıcısının sanal sunucu yerine site koleksiyonu şeklinde olması için doğru değerine ayarlayın. Varsayılan değer null'dur (otomatik algılandı).

SharePoint Kimlik Eşlemesi

Yer Parametre
Kimlik Kaynağı Kimliği api.identitySourceId=1234567890abcdef

Zorunlu. SharePoint Yerel Gruplarını senkronize etmek için kimlik kaynağı kimliği.Arama yapmak için veri kaynağı ekleme başlıklı makalede açıklandığı gibi, Google Workspace yöneticisi tarafından ayarlanan Google Cloud Search kaynak kimliği.
Referans Kimliği Kaynakları api.referenceIdentitySources=CONTOSO,contoso

Etkin dizin ana hesapları için referans kimliği kaynaklarının virgülle ayrılmış listesi. Değer, referans etkin dizin ana hesaplarının Active Directory NETBIOS adıyla eşleşir.
Referans Kimlik Kaynağı Kimlikleri api.referenceIdentitySource.DOMAIN.id=identity-source-id

Zorunlu. Active Directory ana hesaplarını senkronize etmek için kullanılan Kimlik Kaynağı Kimliği.

Active Directory Araması

Yer Parametre
Active Directory Ana Makinesi adLookup.host=host

Zorunlu. dc.contoso.com gibi aktif dizin ana makine adı veya IP adresi.
Active Directory arama bağlantı noktası adLookup.port=port

İsteğe bağlı. Varsayılan değer 389'dur. SSL için 686 kullanın.
Active Directory arama yöntemi adLookup.method=value

İsteğe bağlı. Varsayılan değer "standard"dır. HTTPS bağlantıları için "ssl" olarak ayarlayın.
Active Directory arama kullanıcısı adLookup.username=CONTOSO\user1

Zorunlu. Kullanıcı, etkin dizin aramaları gerçekleştirme yetkisine sahip.
Active Directory arama şifresi adLookup.password=password123

Zorunlu. Kullanıcının şifresi adLookup.user tarafından belirtilmiş.

HTML içeriği oluşturma

Yer Parametre
HTML şablonu başlık alanı contentTemplate.sharePointItem.title=Title

Oluşturulan HTML için HTML şablonu başlığı olarak kullanılacak SharePoint alanı.
HTML içeriği yüksek arama kalitesi alanları contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Oluşturulan HTML'ye yüksek kaliteli alanlar olarak eklenecek alanların virgülle ayrılmış listesi. Arama sorgusu terimleri bu alanlarla eşleştiğinde sonuçlar daha üst sıralanır.
HTML içeriği orta arama kalitesi alanları contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Oluşturulan HTML'ye orta kalitede alanlar olarak eklenecek alanların virgülle ayrılmış listesi.
HTML içeriği düşük arama kalitesi alanları contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Oluşturulan HTML'ye düşük kaliteli alanlar olarak eklenecek alanların virgülle ayrılmış listesi.
HTML içeriği eşlenmemiş sütunlar contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Bağlayıcının eşlenmemiş sütunları işleme şekli. Değer, APPEND (varsayılan) veya IGNORE'dur.

  • UYGULAMAEND - Bağlayıcı, bir kalite seviyesiyle (yüksek, orta veya düşük) ayarlanmamış alanlar da dahil tüm alanlarla HTML içeriği oluşturur.
  • YOK SAY: Bağlayıcı, yalnızca eşlenen alanlarla HTML içeriği oluşturur.