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

Google Cloud Search'ü, Google Workspace içeriğinizin yanı sıra kuruluşunuzun SharePoint şirket içi içeriğinden de sonuç döndürecek şekilde ayarlayabilirsiniz. Belirli bir SharePoint veri kaynağına erişmek için Google Cloud Search SharePoint On-Prem bağlayıcısını kullanır ve yapılandırırsınız.

Dikkat edilecek önemli noktalar

SharePoint ayarları

Cloud Search SharePoint On-Prem bağlayıcısı, SharePoint'teki Search Visibility ayarını her zaman dikkate alır ve bu ayar geçersiz kılınamaz. Taslak dokümanlar için, bağlayıcının SharePoint Online'a erişmek üzere kullandığı kullanıcı hesabındaki izinler, hangi taslak dokümanların dizine ekleneceğini ve döndürüleceğini kontrol eder. Hesabın yalnızca "Tam Okuma" izinleri varsa bağlayıcı, SharePoint'teki "Öğe görünürlüğünü taslak olarak ayarla" 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. Erişim kontrol listelerini tanımlamak için Google asıl kullanıcılarını ve harici asıl kullanıcıları kullanabilirsiniz. SharePoint içeriği için güvenlik kırpma özelliğini uygulamak üzere aşağıdaki harici kimlikleri Google diziniyle senkronize edin:

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

AD kullanıcılarını ve gruplarını senkronize etmek için Google Cloud Directory Sync'i kullanır ve kimliği eşlenmiş grupları etkinleştirirsiniz. SharePoint yerel gruplarını senkronize etmek için SharePoint Identity Connector'ı kullanırsınız.

Bağlayıcının, asıl kullanıcıları senkronize etmek için ek bilgileri getirmek ü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'ini, SharePoint yerel grup üyeliklerinin 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 ayarlamanıza olanak tanır.

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

  • SharePoint içerik türlerinin adlarını ilgili nesne tanımlarıyla 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 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şlenir. "Haber Makalesi" içerik türü, "NewsArticle" ile eşlenir (boşluk yok).

  • Bağlayıcı, bir nesne tanımını bir nesne tanımıyla 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_" öneklerini kaldırarak özellik adlarını normalleştirir, ardından desteklenmeyen karakterleri (A-Z, a-z ve 0-9 dışındaki tüm karakterler) hariç tutar.

Microsoft Outlook iletilerini 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, 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 On-Prem bağlayıcısının gerektirdiği gibi Tam Okuma izni alamazsınız.

Site koleksiyonu modunu etkinleştirmek için:

  • Bağlayıcı kullanıcı hesabına site koleksiyonu yöneticisi izinleri verin.
  • Bağlayıcı yapılandırma dosyanızda sharepoint.server değerini, sharepoint.server gibi site koleksiyonu URL'si olarak ayarlayın.http://sharepoint.example.com/sites/sitecollection URL'nin, SharePoint'tekiyle aynı büyük/küçük harf duyarlılığı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 site koleksiyonlarının her biri için bir bağlayıcı örneği yapılandırmanız gerekir.

Bağlayıcılarla ilgili bilinen sınırlamalar

  • Bağlayıcının, veritabanlarındaki öğelerde yapılan değişiklikleri algılaması için gereken süre, bağlayıcının izlediği veritabanlarının sayısıyla birlikte artar.
  • Bellek tüketimi, her site koleksiyonu için erişim denetim listelerinde kullandığınız benzersiz kullanıcı ve grup sayısıyla artar.
  • Bağlayıcıyı yalnızca tek bir Active Directory alanından gelen kimliklerle yapılandırabilirsiniz.
  • Everyone, BUILTIN\Users ve All Authenticated Users gibi bazı yaygın Active Directory ve Windows yöneticileri desteklenmez.
  • Silme bildirimleri anında gerçekleşmez 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 Java JRE 1.8'in yüklü olması
Kimlik doğrulama
  • NTLM
  • Kerberos
  • HTTP Basic
  • 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 edinme hakkında bilgi edinmek 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ğlayıcı, sonuçları erişim kontrol listelerine göre döndürüyorsa (sonuçlar herkese açık değilse) Google Workspace yöneticinizin iki kimlik kaynağı oluşturması ve bu kaynakları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 alıp size vermesi de gerekir.

    Bu değerleri nasıl alacağınızı Cloud Search'te kullanıcı kimliklerini eşleme başlıklı makaleden öğ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. Herhangi bir site koleksiyonu yazma kilidiyle korunuyorsa 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 vermek 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ısı raporlanır. Kaç bağlayıcı örneğine ihtiyacınız olduğunu, bellek gereksinimlerini ve belge 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. Bağlayıcı deposunu GitHub'dan kopyalayı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

    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ı parametreleri gerekmemesi 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 ayırt etmek için ada ayrıntılar ekleyin.

  2. Dosya içeriğine aşağıdaki örnekte gösterildiği gibi anahtar/değer çiftleri olarak parametreler 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çıklaması için yapılandırma parametreleri referansına gidin.

  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üvenilen ana makine olarak ekleyin

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

  1. Bağlayıcının çalıştırılacağı 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ıya güvenilmiyor" 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 gidip 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çıp aşağıdaki komutu girin:

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

    "Bu sertifikaya güvenilsin mi?" istemi gösterildiğinde evet yanıtını verin.

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ı bir Latin1 kodlu dosya oluşturun.

  3. logging.properties dosyası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

SharePoint On-Prem kimliğe dayalı erişim kontrol listelerini arama sonuçlarına uygulamak için bu adım gereklidir. Bağlayıcıyı herkese açık ACL'lerle kurduysanı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. Dosya içeriğine aşağıdaki örnekte gösterildiği gibi anahtar/değer çiftleri olarak parametreler 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ındaki değerlerle neredeyse aynıdır. Tek fark, 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'deki hem de SharePoint site koleksiyonundaki asıl kullanıcıları 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 koleksiyonu 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 SharePoint 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 ş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 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 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'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ğ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ı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 edinin). Bağlayıcının sharepoint.server sanal sunucu yerine site koleksiyonu olarak dizine eklenmesi için true olarak ayarlayın. Varsayılan değer null'dur (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.Google Workspace yöneticisi tarafından Arama için veri kaynağı ekleme başlıklı makalede açıklandığı şekilde ayarlanan Google Cloud Search kaynak kimliği.
Referans Kimlik Kaynakları api.referenceIdentitySources=CONTOSO,contoso

Active Directory yöneticileri için referans kimlik kaynaklarının virgülle ayrılmış listesi. Değer, referans Active Directory sorumlularının Active Directory NETBIOS adıyla eşleşir.
Referans kimlik kaynağı kimlikleri api.referenceIdentitySource.DOMAIN.id=identity-source-id

Zorunlu. Active Directory yöneticilerini senkronize etmek için kullanılan 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 bağlantı noktası adLookup.port=port

İsteğe bağlı. Varsayılan değer 389'dur. SSL için 686'yı 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 kullanıcısını arama adLookup.username=CONTOSO\user1

Zorunlu. Kullanıcının Active Directory araması yapma yetkisi olmalıdır.
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ğiyle ilgili 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 yüksek sıralarda yer alır.
HTML içeriği orta arama kalitesi alanları contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Oluşturulan HTML'ye orta kaliteli alanlar olarak 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 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ı nasıl işlediği. Değer APPEND (varsayılan) veya IGNORE'dur.

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