Microsoft SharePoint On-Prem Connector'ı 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ı kullanarak belirli bir SharePoint veri kaynağına erişirsiniz.

Dikkat edilmesi gerekenler

Seçilmiş SharePoint ayarları

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

Bağlayıcıyı, sonuçları kullanıcı hesabı erişimine göre sınırlandıracak şekilde de yapılandırabilirsiniz. EKL'leri tanımlamak için Google ana hesaplarını ve harici ana hesapları kullanabilirsiniz. SharePoint içeriği için güvenlik kırpma uygulamak üzere aşağıdaki harici kimlikleri Google Directory 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ştirirsiniz. 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 üzere ek bilgiler almak için AD ile arama da yapması gerekir. Örneğin, AD ile arama, bağlayıcının aşağıdakileri yapmasına izin verir:

  • Bir alan grubunun SID'sini ilgili sAMAccountName ile eşleyin.
  • Bir kullanıcının sAMAccountName değerini SharePoint yerel grup üyelikleri için kullanılan 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'yı kullanmak için SharePoint Online bağlayıcı yapılandırma dosyasında HTML oluşturma parametreleri değerlerini ayarlayın. Bu parametreler, hangi alanların eşleşmeler üzerinde daha fazla veya daha az etkiye sahip olacağını belirlemenize olanak tanır.

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

  • SharePoint içerik türlerinin adlarını karşılık gelen nesne tanımlarına eşlemek için bağlayıcı, desteklenmeyen karakterleri hariç tutarak içerik türü adlarını normalleştirir. Cloud Search API, nesne tanımları için yalnızca AZ, az ve 0-9 karakterlerini geçerli karakterler olarak destekler. Örneğin, "Duyurular" içerik türü, "Duyurular" nesne tanımıyla eşlenir. "Haber Makalesi" içerik türü, "Haber Makalesi" ile eşleşir (boşluksuz).

  • Bağlayıcı, bir nesne tanımını nesne tanımıyla eşleştiremiyorsa 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_" ön eklerini kaldırarak, ardından desteklenmeyen karakterleri (AZ, az ve 0-9 dışındaki tüm karakterler geçerli karakterler olarak) kaldırarak ö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, bu dosyaların medya türünü geçersiz kılıp application/vnd.ms-outlook. olarak dizine ekler.

Çok kiracılı yapılandırmalar

SharePoint'iniz aynı Web uygulamasında birden fazla müşteri sitesinin 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 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 toplama modunu etkinleştirmek için:

  • Bağlayıcı kullanıcı hesabı için site toplama yöneticisi izinleri verin.
  • Bağlayıcı yapılandırma dosyanızda sharepoint.server öğesini site koleksiyonu URL'sine (ör. http://sharepoint.example.com/sites/sitecollection) ayarlayın. URL'nin SharePoint'tekiyle aynı büyük/küçük harf kullanımını içermesi 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 çok site koleksiyonunuz varsa bu site koleksiyonlarından 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, veritabanlarındaki öğelerde yapılan değişiklikleri algılama süresi, bağlayıcının izlediği veritabanı sayısıyla birlikte artar.
  • Bellek kullanımı, her site koleksiyonu için EKL'lerde kullandığınız benzersiz kullanıcıların ve grupların sayısı arttıkça artar.
  • Bağlayıcıyı yalnızca bir Active Directory Alanı'ndan kimliklerle yapılandırabilirsiniz.
  • Yaygın Active Directory ve Windows ana hesapları (örneğin, Everyone, BUILTIN\Users ve All Authenticated Users) 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 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 yüklü olan Java JRE 1.8
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 REST API erişimini yapılandırma başlıklı makaleye bakın.

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

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

    Yönetici, kuruluşunuzun Google Workspace müşteri kimliğini de alıp size vermelidir.

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

  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 bir kök site koleksiyonu yoksa, bir kök site koleksiyonu oluşturun.

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

  7. Bağlayıcı yapılandırmanızı bilgilendirmek amacıyla veri kaynağı metriklerini almak için çiftlik yönetimi ayrıcalıklarına sahip ve diagnose_sp.ps1 çalıştıran bir hesapla SharePoint sunucusunda oturum açın.

    Çıkış, web uygulamalarının, dokümanların ve kullanıcı grubu üyeliklerinin sayısını bildirir. Bu bilgileri kullanarak kaç bağlayıcı örneğine ihtiyacınız olduğunu, bellek gereksinimlerini ve belge sayısını tahmin edebilirsiniz.

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üne göz atın:

    $ 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ı 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ı parametrelerine gerek olmaması amacıyla dosyayı connector-config.properties olarak adlandırmanızı önerir. Çok sayıda bağlayıcı örneği çalıştırmayı planlıyorsanız bu adı 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 çifti 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ı) Gerektiğinde ek bağlayıcı parametrelerini yapılandırın. Ayrıntılar için Google tarafından sağlanan bağlayıcı parametreleri bölümüne bakın.

3. Adım. HTTPS için, güvenilir ana makine olarak SharePoint'i 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 Anlıyorum'u 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üvenilir Değil" gibi bir ileti gösterilir.

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

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

  5. Sertifikayı, sharepoint.crt adlı bağlayıcı dizinine kaydedin.

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

  7. Bir komut istemi penceresi 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?" sorusunu gördüğünüzde 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 adlı bir Latin1 kodlu dosyası oluşturun.

  3. logging.properties metnini şu metne 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 ayarladıysanız bu adımı atlayabilirsiniz.

  1. SharePoint Online bağlayıcısı kurulumuyla aynı dizinde bir dosya oluşturun ve bu dosyayı 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 çifti 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ının değerleriyle hemen hemen aynıdır. Bunun tek istisnası, api.sourceId yerine api.customerId parametresinin kullanılması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 hem de SharePoint sitesi koleksiyonundaki ana hesapları, Google Cloud Identity hizmetindeki kimliklerle eşlersiniz. 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 koleksiyon gruplarını senkronize etmek için SharePoint On-Prem kimlik bağlayıcısını çalıştırın. Son olarak, Cloud Search kullanıcılarınıza dizin oluşturmak ve sonuçları 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 sitenizin güvenliği 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 ekleme):

      $ 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

Tema 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şim

Tema Parametre
SharePoint sunucusu URL'si sharepoint.server=http://yoursharepoint.example.com/

Zorunlu. Tam nitelikli bir ana makine adı olarak SharePoint sunucusunun URL'si (http://yoursharepoint.example.com/ gibi). Ana makine adı tam nitelikli 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 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ğ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ını 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

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

Çok kiracılı SharePoint dağıtımları hariç isteğe bağlı (daha fazla bilgi). Bağlayıcı dizininin (sharepoint.server) sanal bir sunucu yerine site koleksiyonu olarak alınması için true değerini alın. Varsayılan değer null'dur (otomatik algılanan).

SharePoint Kimliği Eşleme

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

Zorunlu. SharePoint Yerel Gruplarını senkronize etmek için kullanılan kimlik kaynağı kimliği.Google Arama'ya veri kaynağı ekleme başlıklı makalede açıklandığı gibi, Google Workspace yöneticisi tarafından oluşturulan Google Cloud Search kaynak kimliği.

Referans Kimlik Kaynakları api.referenceIdentitySources=CONTOSO,contoso

Etkin dizin ana hesapları için referans kimlik kaynaklarının virgülle ayrılmış listesi. Değer, referans etkin dizin ana öğelerinin Active Directory NETBIOS adıyla eşleşiyor.

Referans Kimliği Kaynak Kimlikleri api.referenceIdentitySource.DOMAIN.id=identity-source-id

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

Active Directory Araması

Tema Parametre
Active Directory Ana Makinesi adLookup.host=host

Zorunlu. dc.contoso.com veya IP adresi gibi Active Directory ana makine adı.

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 (standart). HTTPS bağlantıları için "ssl" olarak ayarlayın.

Active Directory araması kullanıcısı adLookup.username=CONTOSO\user1

Zorunlu. Kullanıcı, etkin dizin aramaları yapmaya yetkili.

Active Directory arama şifresi adLookup.password=password123

Zorunlu. adLookup.user tarafından belirtilen kullanıcının şifresi.

HTML içeriği oluşturma

Tema Parametre
HTML şablon başlığı 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 alan olarak eklenecek alanların virgülle ayrılmış listesi. Arama sorgusu terimleri bu alanlarla eşleştiğinde, sonuçlar daha üst sıralarda yer alır.

HTML içerik aracısı 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 alan olarak eklenecek alanların virgülle ayrılmış listesi.

Eşlenmemiş HTML içeriği sütunları contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

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

  • UYGULAMA EKLEME - Bağlayıcı, yüksek kaliteyle (yüksek, orta veya düşük) ayarlanmamış alanlar da dahil olmak üzere tüm alanları içeren HTML içeriği oluşturur.
  • IGNORE - Bağlayıcı yalnızca eşlenmiş alanlara sahip HTML içeriği oluşturur.