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

Honored SharePoint ayarları

Cloud Search SharePoint On-Prem bağlayıcısı, her zaman SharePoint'te geçersiz kılınamayan Arama Görünürlüğü ayarını dikkate alır. Taslak dokümanlarda, kullanıcı hesabındaki izinler (bağlayıcının SharePoint Online'a erişmek için kullandığı) hangi taslak dokümanların dizine ekleneceğini ve döndürüleceğini kontrol eder. Hesapta yalnızca "Tam Okuma" izinleri varsa 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ını kullanabilirsiniz. SharePoint içeriği için güvenlik kırpması uygulamak üzere aşağıdaki harici kimlikleri Google Dizin ile senkronize edin:

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

AD kullanıcılarını ve gruplarını senkronize etmek için Google Cloud Directory Sync'i kullanarak kimlik eşlemesi yapılmış grupları etkinleştirin. SharePoint yerel gruplarını senkronize etmek için SharePoint Identity Connector'ı kullanın.

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

  • Bir alan grubunun SID'sini, ilgili sAMAccountName ile eşleyin.
  • Bir kullanıcı sAMAccountName öğesini SharePoint yerel grup üyeliklerinin e-posta adresine 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 parametreleri değerlerini ayarlayın. Bu parametreler, eşleşmeler üzerinde hangi alanların daha yüksek veya daha düşük etkiye sahip olacağını ayarlamanıza olanak tanır.

Şema oluşturmak için Şema oluşturma ve kaydetme başlıklı makalede verilen talimatları uygulayın. Bir şema oluşturduğunuzda:

  • Bağlayıcı, SharePoint içerik türlerinin adlarını karşılık gelen nesne tanımlarıyla eşlemek için desteklenmeyen karakterleri hariç tutarak içerik türü adlarını normalleştirir. Cloud Search API nesne tanımları için geçerli karakterler olarak yalnızca A-Z, a-z ve 0-9 karakterlerini 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şiyor (boşluk yok).

  • Bağlayıcı bir nesne tanımını bir 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.

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

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 dosyaları 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 koleksiyonu modunu yapılandırmanız gerekir. Çok kiracılı dağıtımlarda, yalnızca site koleksiyonunuz için izinler alırsınız ve SharePoint On-Prem bağlayıcısının gerektirdiği şekilde Tam Okuma izinlerini alamazsınız.

Site koleksiyonu modunu etkinleştirmek için:

  • Bağlayıcı kullanıcı hesabına site koleksiyonu yöneticisi izinlerini 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'tekiyle tam olarak aynı büyük/küçük harf kullanımını kullanması gerekmez.
  • Bağlayıcı yapılandırma dosyanızda sharepoint.siteCollectionOnly öğesini true olarak ayarlayın.

Çok kiracılı bir ortamda dizine eklenecek birden fazla site koleksiyonunuz varsa site koleksiyonlarının her biri 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ı sayısıyla birlikte, bağlayıcının veritabanlarındaki öğelerde yapılan değişiklikleri algılaması için geçen süre artar.
  • Her bir site koleksiyonu için EKL'lerde kullandığınız benzersiz kullanıcı ve grupların sayısıyla birlikte bellek tüketimi de artar.
  • Bağlayıcıyı yalnızca tek bir Active Directory Alanı'ndan kimliklerle yapılandırabilirsiniz.
  • Everyone, BUILTIN\Users ve All Authenticated Users gibi bazı ortak Active Directory ve Windows ana hesapları desteklenmez.
  • Silme bildirimleri anlık değildir ve bir bağlayıcının, kullanıcı tarafından kaynak depodan içerik sildiğini tanıması 4 saatten uzun 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. Nasıl özel anahtar alacağınızı öğrenmek için Google Cloud Search API'ye erişimi yapılandırma bölümüne gidin.

  2. Google Workspace yöneticinizin aramaya 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ğilse) Google Workspace yöneticinizin iki kimlik kaynağı oluşturması ve bunların kimliklerini size vermesi gerekir:

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

    Yöneticinin, kuruluşunuzun Google Workspace müşteri kimliğini de alması ve size vermesi gerekir.

    Bu değerleri nasıl alacağınızı Cloud Search'te kullanıcı kimliklerini eşleme bölümünden öğrenebilirsiniz.

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

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

  6. Yazma kilidi olan site koleksiyonları 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 sağlayacak veri kaynağı metriklerini almak için çiftlik yönetimi ayrıcalıklarına sahip bir hesapla SharePoint sunucusunda oturum açın ve diagnose_sp.ps1'i çalıştırın.

    Çı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 doküman sayısını tahmin etmek için bu bilgileri kullanın.

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 istenen sürümünü kontrol edin:

    $ git checkout tags/latest_version

    Burada: latest_version = v1-0.0.5 gibi bir değer

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

    $ mvn package

    Bağlayıcıyı derlerken 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ı parametrelerine gerek kalmaması için dosyayı connector-config.properties olarak adlandırmanızı önerir. Çok sayıda bağlayıcı örneği çalıştırmayı planlıyorsanız, bağlayıcıyı ayırt etmek için ada ayrıntılar ekleyin.

  2. Parametreleri, aşağıdaki örnekte olduğu 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 parametrenin ayrıntılı açıklamaları için yapılandırma parametreleri referansı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çın ve SharePoint'e gidin.

  2. Açılan uyarı sayfasında Riskleri Anladım 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 ileti 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ı bağlayıcı dizinine sharepoint.crt adıyla 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 kodlamalı bir dosya oluşturun.

  3. Şu metni logging.properties adlı reklam grubuna 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 kimlik tabanlı EKL'leri 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ı kurulumuyla aynı dizinde bir dosya oluşturun ve sharepoint-onprem-identity-connector.config olarak adlandırın.

  2. Parametreleri, aşağıdaki örnekte olduğu 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, SharePoint On-Prem bağlayıcısıyla neredeyse aynıdır ancak api.sourceId yerine api.customerId parametresi kullanılı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 hem de SharePoint site 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 site koleksiyonu gruplarını senkronize etmek için SharePoint On-Prem kimlik bağlayıcısını çalıştırın. Son olarak, sonuçları dizine eklemek ve Cloud Search kullanıcılarınıza 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ıp ç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 gerekli değildir):

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

    • HTTPS (güvenilir ana makine olarak SharePoint'i 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

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

Zorunlu. Google Workspace yöneticisi tarafından ayarlanan 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

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

Zorunlu. Tam ana bilgisayar adı olarak SharePoint sunucusunun URL'si (ör. http://paylaşımnoktanız.example.com/). Ana makine adı tam değilse bağlayıcı ana makinesinde 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 gereklidir.
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 gereklidir.
SharePoint'e bağlanmak için Canlı Kimlik Doğrulama'yı 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 koleksiyonunu dizine ekleme

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

Çok kiracılı SharePoint dağıtımları hariç isteğe bağlıdır (daha fazla bilgi edinin). sharepoint.server bağlayıcısının bir sanal sunucu yerine site koleksiyonu olarak dizine eklenmesi için bağlayıcıyı true olarak ayarlayın. Varsayılan değer boştur (otomatik algılandı).

SharePoint Identity Eşlemesi

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

Zorunlu. SharePoint Yerel Gruplarını senkronize etmek için kimlik kaynağı kimliği.Aramaya veri kaynağı ekleme bölümünde açıklandığı şekilde, 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 Active Directory 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ı

Ayar Parametre
Active Directory Ana Makinesi adLookup.host=host

Zorunlu. dc.contoso.com gibi bir Active Directory 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 "standard" (standart) seçeneğidir. HTTPS bağlantıları için "ssl" değerine 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 araması şifresi adLookup.password=password123

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

HTML içeriği oluşturma

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

Oluşturulan HTML için HTML şablon 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ırada gösterilir.
HTML içerik 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 değeridir.

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