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

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

Dikkat edilmesi gerekenler

Uygulanan SharePoint ayarları

Cloud Search SharePoint Yerleşik bağlayıcısı, SharePoint'taki Arama Görünümü ayarını her zaman dikkate alır. Bu ayar geçersiz kılınamaz. Taslak belgelerde, hangi taslak belgelerin dizine ekleneceğini ve döndürüleceğini kullanıcı hesabındaki izinler (bağlantılayıcının SharePoint Online'a erişmek için kullandığı) kontrol eder. Hesapta yalnızca "Tam Okuma" izinleri varsa bağlayıcı, SharePoint'taki "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. ACL'leri tanımlamak için Google ve harici asıl kişileri kullanabilirsiniz. SharePoint içeriği için güvenlik kırpma işlemini uygulamak üzere aşağıdaki harici kimlikleri Google dizini ile senkronize edin:

  • Active Directory Kullanıcıları
  • Active Directory Grupları
  • SharePoint yerel grupları (üye olarak Active Directory kullanıcıları ve grupları içeren)

AD kullanıcılarını ve gruplarını senkronize etmek için Google Cloud Directory Sync'i kullanarak kimlik eşlenen grupları etkinleştirin. SharePoint yerel gruplarını senkronize etmek için SharePoint Kimlik Bağlantısı'nı kullanırsınız.

Bağlantıcının, kimlikleri senkronize etmek için ek bilgiler almak üzere AD ile arama yapması da 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ının sAMAccountName özelliğini SharePoint yerel grup üyeliklerinin e-posta adresiyle eşleyin.

Arama optimizasyonu

Bağlantı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ğdaştırıcısı yapılandırma dosyasında HTML oluşturma parametrelerinin değerlerini ayarlayın. Bu parametreler, eşleşmeler üzerinde hangi alanların 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ı makalede yer alan talimatları uygulayın. Şema oluşturduğunuzda:

  • Bağlayıcı, SharePoint içerik türlerinin adlarını ilgili nesne tanımlarıyla eşleştirmek için desteklenmeyen karakterleri hariç tutarak içerik türü adlarını normalleştirir. Cloud Search API, nesne tanımları için geçerli karakter olarak yalnızca A-Z, a-z ve 0-9'u destekler. Örneğin, "Duyuru" içerik türü, "Duyuru" nesne tanımı ile eşlenir. "Haberler Makalesi" içerik türü, "NewsArticle" ile eşlenir (boşluk yok).

  • Bağlayıcı, bir nesne tanımını başka bir nesne tanımı ile eşleştiremediğinde 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 kodlu karakterlerin kodunu çözerek ve "ows_" ön eklerinin kaldırılmasını sağlayarak özellik adlarını normalleştirir, ardından desteklenmeyen karakterleri (geçerli karakterler olarak A-Z, a-z ve 0-9 hariç tüm karakterler) hariç tutar.

Microsoft Outlook ileti işleme

İçerik dizine eklenirken bağlayıcı 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, 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 koleksiyonu modunu yapılandırmanız gerekir. Çok kiracılı dağıtımlarda yalnızca site koleksiyonunuz için izin alırsınız ve SharePoint Yerleşik bağlayıcısı tarafından gerekli olan Tam Okuma izinlerini alamazsınız.

Site koleksiyonu modunu etkinleştirmek için:

  • Bağlantılayıcı kullanıcı hesabına site koleksiyonu yöneticisi izinleri verin.
  • Bağlayıcı yapılandırma dosyanızdaki sharepoint.server değerini site koleksiyonu URL'sine (ör. http://sharepoint.example.com/sites/sitecollection) ayarlayın. URL'nin, SharePoint'takiyle tam olarak aynı büyük/küçük harf kullanımına sahip olması gerekmez.
  • Bağlayıcı yapılandırma dosyanızdaki sharepoint.siteCollectionOnly değerini 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 konnektör sınırlamaları

  • Bağlayıcının, veritabanlarındaki öğelerdeki değişiklikleri algılaması için gereken süre, bağlayıcının izlediği veritabanlarının sayısıyla artar.
  • Bellek tüketimi, her site koleksiyonu için ACL'lerde kullandığınız benzersiz kullanıcı ve grup sayısıyla artar.
  • Bağlantıyı yalnızca bir Active Directory alanındaki kimliklerle yapılandırabilirsiniz.
  • Everyone, BUILTIN\Users ve All Authenticated Users gibi yaygın Active Directory ve Windows ilkeleri desteklenmez.
  • Silme bildirimleri anında gönderilmez ve bir bağlayıcının, kullanıcının kaynak deposundaki içeriği sildiğini algılaması 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 Yerel Bağlayıcı'yı çalıştıracak bilgisayara Java JRE 1.8 yüklenmiş olmalıdır.
Kimlik doğrulama
  • NTLM
  • Kerberos
  • HTTP Temel
  • 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 almayı öğ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 veri kaynağı eklemesi gerekir. Veri kaynağı kimliğini kaydedin.

  3. Bağlantılayıcı, ACL'lere göre sonuçlar döndürüyorsa (sonuçlar herkese açık değildir) Google Workspace yöneticinizin iki kimlik kaynağı oluşturması ve 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önetici, kuruluşunuzun Google Workspace müşteri kimliğini de alıp size vermelidir.

    Bu değerleri nasıl alacağınızı Cloud Search'te kullanıcı kimliklerini eşleme başlıklı makalede öğrenebilirsiniz.

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

  5. SharePoint web uygulamasında kök site koleksiyonu yoksa bir tane oluşturun.

  6. Yazma kilidi uygulanmış 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ızı bilgilendirmek için veri kaynağı metriklerini almak üzere SharePoint sunucusunda çiftlik yönetimi ayrıcalıklarına sahip bir hesapla oturum açın ve diagnose_sp.ps1 komutunu çalıştırın.

    Çıkışta web uygulamalarının, dokümanların ve kullanıcı grubu üyeliklerinin sayıları raporlanır. Kaç bağlayıcı örneğine, bellek gereksinimlerine ve doküman sayısına ihtiyacınız olduğunu tahmin etmek için bu bilgileri kullanın.

1. Adım: Google Cloud Search SharePoint şirket içi bağlayıcı yazılımını yükleyin.

  1. Bağlantı deposunu GitHub'dan kopyalayın.

    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. Bağlayıcının istenen 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ğlantı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ı yüklemesiyle aynı dizinde bir dosya oluşturun. Google, bağlayıcıyı çalıştırmak için ek komut satırı parametrelerine gerek kalmaması amacıyla dosyayı connector-config.properties olarak adlandırmanızı önerir. Birçok bağlayıcı örneği çalıştırmayı planlıyorsanız ayırt etmek için isme ayrıntılar ekleyin.

  2. Aşağıdaki örnekte gösterildiği gibi, parametreleri 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ı başlıklı makaleyi inceleyin.

  3. (İsteğe bağlı) Gerekirse ek bağlayıcı parametrelerini yapılandırın. Ayrıntılar için Google tarafından sağlanan bağlayıcı parametreleri başlıklı makaleyi inceleyin.

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

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

  1. Bağlantıyı çalıştıracak bilgisayarda bir tarayıcı açıp SharePoint'a 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 mesaj gösterilir.

  3. Görüntüle düğmesi kullanılabilir hale geldiğinde 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üvenilir mi?" sorusunu evet olarak yanıtlayın.

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

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

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

  3. logging.properties alanına aşağıdaki metni 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 şirket içi kimlik bağlayıcısını yapılandırma

Bu adım, SharePoint Yerel Kimliğe Dayalı ACL'lerinin arama sonuçlarına uygulanması için gereklidir. Bağlantıyı herkese açık ACL'lerle kuruyorsanız bu adımı atlayabilirsiniz.

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

  2. Aşağıdaki örnekte gösterildiği gibi, parametreleri 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 Yerel Bağlantısı ile neredeyse aynıdır. Tek fark, parametrenin api.sourceId yerine api.customerId olmasıdır. api.customerId değeri, Google Workspace yöneticinizden aldığınız müşteri kimliğidir.

6. Adım: SharePoint şirket içi bağlayıcısını başlatma

Aşağıdaki adımlarda, hem şirket içi Active Directory'deki hem de SharePoint site koleksiyonundaki kimlikleri Cloud Identity hizmetindeki kimliklerle eşlersiniz. Bu senkronizasyon, Google Cloud Directory Sync (GCDS) ve SharePoint Yerel 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 Yerleşik kimlik bağlayıcısını çalıştırın. Son olarak, Cloud Search kullanıcılarınıza sonuçları dizine eklemek ve sunmak için SharePoing şirket içi 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 şirket içi 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 şirket içi 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 (güvenilir ana makine olarak SharePoint'ı 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 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

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

Zorunlu. SharePoint sunucusunun URL'si (tam nitelikli ana makine adı olarak) (ör. http://yoursharepoint.example.com/). Ana makine adı tam nitelikli değilse bağlayıcı ana makinesinde DNS geçersiz kılma ayarını yapmanız gerekir.

SharePoint kullanıcı adı sharepoint.username=YOURDOMAIN\\ConnectorUser

Bağlayıcıyı Linux'te 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'te veya SharePoint Server AD alanının parçası olmayan bir Windows makinesinde çalıştırdığınızda gereklidir.

SharePoint'a bağlanmak için canlı kimlik doğrulamayı kullanma sharepoint.username=AdaptorUser Live Authentication Id

sharepoint.password uS3R_passWoRD

sharepoint.formsAuthenticationMode=LIVE

SharePoint'a 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

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). Bağlayıcı dizini sharepoint.server'ü sanal sunucu yerine site koleksiyonu olarak kullanmak için doğru olarak ayarlayın. Varsayılan değer null (otomatik olarak algılanır).

SharePoint Kimlik Eşleme

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

Zorunlu. SharePoint yerel gruplarını senkronize etmek için kimlik kaynağı kimliği.Arama için veri kaynağı ekleme bölümünde açıklandığı gibi, Google Workspace yöneticisi tarafından ayarlanan Google Cloud Search kaynak kimliği.

Referans kimlik kaynakları api.referenceIdentitySources=CONTOSO,contoso

Etkin dizin yetkilileri için referans kimlik kaynaklarının virgülle ayrılmış listesi. Değer, referans etkin dizin kimliklerinin Active Directory NETBIOS adıyla eşleşir.

Referans kimlik kaynağı kimlikleri api.referenceIdentitySource.DOMAIN.id=identity-source-id

Zorunlu. Active Directory yetkililerini senkronize etmek için kimlik kaynağı kimliği.

Active Directory Arama

Yer Parametre
Active Directory Ana Makinesi adLookup.host=host

Zorunlu. Active Directory ana makine adı (ör. dc.contoso.com) veya IP adresi.

Active Directory arama noktası adLookup.port=port

İsteğe bağlı. Varsayılan değer 389'dur. SSL için 686 numaralı bağlantı noktasını 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. Active Directory aramaları gerçekleştirme yetkisi olan kullanıcı.

Active Directory arama şifresi adLookup.password=password123

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

HTML içeriği oluşturma

Yer 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 dahil edilecek 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çeriği orta arama kalitesi alanları contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Orta kaliteli alanlar olarak oluşturulan HTML'ye dahil edilecek 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 dahil edilecek alanların virgülle ayrılmış listesi.

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

Bağlayıcı, eşlenmemiş sütunları nasıl işler? Değer APPEND (varsayılan) veya IGNORE olur.

  • APPEND: Bağlantılayıcı, kalite seviyesi (yüksek, orta veya düşük) ayarlanmamış alanlar da dahil olmak üzere tüm alanlarla HTML içeriği oluşturur.
  • IGNORE: Bağlayıcı, yalnızca eşlenen alanlar içeren HTML içeriği oluşturur.