Microsoft SharePoint Online bağlayıcısını dağıtma

Google Cloud Search'ü, Google Workspace içeriğinizin yanı sıra kuruluşunuzun SharePoint Online içeriğinden de sonuç döndürecek şekilde ayarlayabilirsiniz. Cloud Search SharePoint Online bağlayıcısını kullanın ve belirli bir SharePoint Online veri kaynağına erişecek şekilde yapılandırın.

Dikkat edilecek önemli noktalar

SharePoint Online bağlayıcısını dağıtmadan önce aşağıdaki noktaları göz önünde bulundurun.

Kullanılan SharePoint ayarları

Bağlayıcı, SharePoint'teki Arama Görünürlüğü ayarına her zaman uyar. Taslak belgeler için, bağlayıcının SharePoint Online'a erişmek üzere kullandığı kullanıcı hesabındaki izinler, hangi taslak belgelerin dizine ekleneceğini ve döndürüleceğini kontrol eder. Hesapta yalnızca "Tam Okuma" izinleri varsa bağlayıcı, "Öğe görünürlüğünü taslak olarak ayarla" ayarlarını dikkate alır.

Ayrıca, bağlayıcıyı kullanıcı hesabı erişimine göre sonuçları sınırlayacak şekilde yapılandırırsınız. Güvenlik kırpma işlemini uygulamak için bu harici kimlikleri Google Cloud Directory ile senkronize edin:

  • Office 365 / Azure AD kullanıcıları.
  • Office 365 / Azure AD güvenlik grupları.
  • SharePoint grupları (üye olarak Office 365 kullanıcıları ve gruplarıyla).

Arama optimizasyonu

Bağlayıcıyı alakalı sonuçlar döndürecek şekilde yapılandırarak arama deneyimini iyileştirin. Alan etki düzeylerini ayarlamak için yapılandırma dosyasında HTML oluşturma parametrelerini kullanın.

Şema oluşturmak için Create and register a schema (Şema oluşturma ve kaydetme) başlıklı makaleyi inceleyin. Şema oluştururken:

  • Bağlayıcı, SharePoint içerik türlerini geçerli nesne tanımı adlarına (A-Z, a-z, 0-9) göre normalleştirir. Örneğin, "Haber Makalesi" yerine "HaberMakalesi" yazılır.
  • Bağlayıcı bir nesne tanımıyla eşleşemezse yedek nesne türünü (itemMetadata.objectType) kullanır. Meta veri yapılandırma parametreleri bölümüne bakın.
  • Bağlayıcı, SharePoint özellik adlarını özellik tanımlarıyla eşler.
  • Konnektör, Microsoft Outlook .msg dosyalarının medya türünü geçersiz kılar ve bunları application/vnd.ms-outlook olarak indeksler.

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

  • Her bağlayıcı örneği, yalnızca tek bir site koleksiyonundaki içeriği dizine ekler. Birden fazla site koleksiyonunu dizine eklemek için ek örnekler oluşturun.
  • Bellek tüketimi, ACL'lerdeki benzersiz kullanıcı ve grup sayısıyla artar.
  • Silme bildirimlerinin yayılması 4 saatten uzun sürebilir.

Sistem gereksinimleri

Sistem gereksinimleri
İşletim sistemi Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0 veya SUSE Enterprise Linux 10 (64 bit).
Kimlik doğrulama Canlı Kimlik Doğrulama
Yazılım SharePoint Online ortamı; Java JRE 1.8.

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

SharePoint Online bağlayıcısını dağıtmak için aşağıdaki adımları uygulayın.

Ön koşullar

  1. Google Workspace özel anahtarı oluşturun. Cloud Search API'ye erişimi yapılandırma başlıklı makaleyi inceleyin.
  2. Arama yapmak için veri kaynağı ekleyin ve kimliğini kaydedin. Aramaya veri kaynağı ekleme başlıklı makaleyi inceleyin.
  3. ACL tabanlı sonuçlar için yöneticinizin iki kimlik kaynağı (biri Office 365, diğeri SharePoint grupları için) oluşturması ve Google Workspace müşteri kimliğini sağlaması gerekir. Kullanıcı kimliklerini eşleme başlıklı makaleyi inceleyin.
  4. SharePoint Online Site Koleksiyonu Yöneticisi ayrıcalıklarına sahip bir bağlayıcı kullanıcı hesabı oluşturun.
  5. Group.Read.All ve User.Read.All izinleriyle Azure Active Directory uygulama kimlik bilgileri oluşturun. Uygulama kimliğini, kiracıyı ve istemci gizli anahtarını not edin.

1. Adım: Bağlayıcı yazılımını yükleme

  1. Kod deposunu klonlayın: 
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
$ cd sharepoint-connector
  2. Seçtiğiniz sürümü inceleyin (ör. v1-0.0.3): 
    $ git checkout tags/v1-0.0.3
  3. Bağlayıcıyı oluşturun: 
    $ mvn package
     Testleri atlamak için mvn package -DskipTests simgesini kullanın.
  4. ZIP dosyasını kurulum dizininize çıkarın.

2. adım: Yapılandırma dosyasını oluşturma

Yükleme dizininde sharepoint-online-connector.config oluşturun. Parametreleri aşağıdaki örnekte gösterildiği gibi anahtar/değer çiftleri olarak ekleyin:

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=password
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE
api.identitySourceId=08ef8becd116faa475de26d9b291fed9
api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Ayrıntılar için referans veya Google tarafından sağlanan parametreler bölümüne bakın.

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

Bu içeriğe sahip bir logs klasörü ve bir logging.properties dosyası oluşturun:

   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

4. Adım. SharePoint kimlik bağlayıcısını yapılandırma

Kimliğe dayalı erişim kontrol listelerini uygulamak için api.customerId ile sharepoint-online-identity-connector.config oluşturun ve diğer bağlantı parametrelerini aşağıdaki örnekte olduğu gibi ayarlayın:

```properties
### SharePoint Online identity connector configuration ###
# Required parameters for data source access
api.customerId=C05d3djk8
api.serviceAccountPrivateKeyFile=service_account.json

# Required parameters for SharePoint Online access
sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=pa$sw0rd
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE

# SharePoint identity mapping parameters
api.identitySourceId=08ef8becd116faa475de26d9b291fed9
api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa
```

5. Adım: Office 365 kimlik bağlayıcısını yükleme

SharePoint Online kimliğe dayalı erişim kontrol listelerini kullanıyorsanız bu adımı uygulayın. Herkese açık ACL'ler kullanıyorsanız bu adımı atlayın.

  1. Office 365 deposunu klonlayın:

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

  2. mvn package kullanarak bağlayıcıyı inceleyin ve oluşturun.

  3. ZIP dosyasını kurulum dizininize çıkarın.

6. Adım: Office 365 kimlik bağlayıcısını yapılandırma

  1. Kimlik bağlayıcı yüklemesiyle aynı dizinde o365-identity-connector.config adlı bir dosya oluşturun ve parametreleri anahtar/değer çiftleri olarak ekleyin:

    ### Office 365 Identity connector configuration ###
api.identitySourceId=<var>12345abcde</var>
api.customerId=<var>abcde12345</var>
o365.clientId=<var>a63c6eb3-29e7-486</var>
o365.tenant=<var>185ef9ed-29e7-486</var>
o365.clientSecret=<var>raHJN15vRLBKs</var>

    Parametre açıklamaları için Office 365 kimlik bağlayıcısı bölümüne bakın.

  2. Aynı dizinde logs adlı bir klasör oluşturun.

  3. Aynı dizinde, aşağıdaki içeriğe sahip logging.properties adlı bir dosya oluşturun:

       handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
   # Default log level
   .level = INFO
   # uncomment line below to increase logging level for Office 365 APIs
   #com.google.enterprise.cloudsearch.o365.level=FINE

   # uncomment line below to increase logging level to enable Google API traces
   #com.google.api.client.http.level = FINE
   java.util.logging.ConsoleHandler.level = INFO
   java.util.logging.FileHandler.pattern=logs/connector-o365.%g.log
   java.util.logging.FileHandler.limit=10485760
   java.util.logging.FileHandler.count=10
   java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

7. Adım: Bağlayıcıyı başlatma

Bağlayıcıları yapılandırdıktan sonra senkronizasyonu ve dizine ekleme işlemini başlatmak için bunları çalıştırın. Her komutu kendi terminal penceresinde çalıştırın.

  1. Kullanıcıları ve grupları senkronize etmek için Office 365 kimlik bağlayıcısını çalıştırın:

    $ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-office-365-connector-v1-0.0.3.jar -Dconfig=o365-identity-connector.config

  2. Site koleksiyonu gruplarını senkronize etmek için SharePoint Online kimlik bağlayıcısını çalıştırın:

    $ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -Dconfig=sharepoint-online-identity-connector.config

  3. İçeriği dizine eklemek için SharePoint Online bağlayıcısını çalıştırın:

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

Yapılandırma parametreleri referansı

Aşağıdaki bölümlerde, SharePoint Online bağlayıcısını yapılandırmak için kullanılan yapılandırma parametreleri listelenmektedir.

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 Online erişimi

Ayar Parametre
SharePoint sitesi koleksiyonunun tam nitelikli alan adı sharepoint.server=http://yoursharepoint.example.com/

Zorunlu. Alan adı tam nitelikli değilse bağlayıcı ana makinesinde DNS geçersiz kılma ayarını yapın.
Yalnızca site koleksiyonu modu sharepoint.siteCollectionOnly=true

Zorunlu. SharePoint Online için değeri true olarak ayarlayın.
SharePoint kullanıcı adı sharepoint.username=username

Zorunlu. SharePoint Online'a erişmek için kullanılan hesabın kullanıcı adı.
SharePoint şifresi sharepoint.password=user_password

Zorunlu. SharePoint Online'a erişmek için kullanılan hesabın şifresi.
Kimlik Doğrulama Modu sharepoint.formsAuthenticationMode=LIVE

Zorunlu. SharePoint Online için değer her zaman "LIVE" olur.
Dağıtım Türü sharepoint.deploymentType=ONLINE

Zorunlu. SharePoint Online için değer her zaman "ONLINE" olur.

SharePoint Kimlik Eşleme

Ayar Parametre
Kimlik kaynağı kimliği api.identitySourceId=1234567890abcdef

Zorunlu. SharePoint grupları kimlik kaynağı için Cloud Search kimlik kaynağı kimliği.
Kimlik Kaynaklarına Referans Verme api.referenceIdentitySources=defaultIdentitySource

Zorunlu. SharePoint Online için değer her zaman "defaultIdentitySource" olur.
Referans kimlik kaynağı kimlikleri api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

Zorunlu. Office 365 Kullanıcıları ve Grupları kimlik kaynağı için Cloud Search kimlik kaynağı kimliği.

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ğ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 üst 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ış olanlar da dahil olmak üzere tüm alanları içeren HTML içeriği oluşturur.
  • IGNORE (YOK SAY): Bağlayıcı, yalnızca eşlenen alanlarla HTML içeriği oluşturur.

Office 365 kimlik bağlayıcı yapılandırması

Ayar Parametre
Kimlik kaynağı kimliği api.identitySourceId=1234567890abcdef

Zorunlu. Office 365 kimlik kaynağı kimliği. Bu değer, SharePoint Online bağlayıcı yapılandırmasındaki `api.referenceIdentitySource.defaultIdentitySource.id` değerine karşılık gelmelidir.
Google müşteri kimliği api.customerId=c1b1d1e1

Zorunlu. Kuruluşunuzun Google Workspace müşteri kimliği.
Office 365 Uygulama Kimliği o365.clientId=a63c6eb3-29e7-486

Zorunlu. Office 365 uygulama kurulumundan alınan uygulama kimliği.
Office 365 kiracısı o365.tenant=185ef9ed-29e7-486

Zorunlu. Office 365 hesabınızın kiracısı (Azure Activity Directory uygulamanız)
Office 365 istemci gizli anahtarı o365.clientSecret=raHJN15vRLBKs

Zorunlu. Office 365 uygulama kurulumundan alınan kimlik bilgisi gizli anahtarı