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

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

Dikkat edilmesi gerekenler

Honored SharePoint ayarları

Cloud Search SharePoint Online 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ümanlar için, kullanıcı hesabındaki izinler (bağlayıcının SharePoint Online'a erişmek için kullandığı izinler) 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ırırsınız. SharePoint içeriği için güvenlik kırpması uygulamak üzere aşağıdaki harici kimlikleri Google Dizin ile senkronize edersiniz:

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

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.

Bir ş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şler.

  • Bağlayıcı, içeriği dizine eklerken Microsoft Outlook .msg dosyalarıyla karşılaştığında dosyaların içerik türünü geçersiz kılar ve dosyaları application/vnd.ms-outlook. olarak dizine ekler

Bilinen bağlayıcı sınırlamaları

  • Her bir bağlayıcı örneği, yalnızca tek bir site koleksiyonundaki içeriği dizine ekleyebilir. Birden çok site koleksiyonunu dizine eklemek için ek bağlayıcı örnekleri ayarlayın.
  • 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.
  • 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)
Kimlik doğrulama
  • Canlı Kimlik Doğrulama
Yazılım
  • SharePoint Online ortamı
  • Google Cloud Search SharePoint Online bağlayıcısını çalıştıracak bilgisayarda Java JRE 1.8 yüklü

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:

    • Office 365 kullanıcıları ve grupları için bir tane
    • diğeri SharePoint grupları için

    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. Bağlayıcı için SharePoint Online Site Collection Yöneticisi ayrıcalıklarına sahip bir kullanıcı hesabı oluşturun.

  5. Bağlayıcı, EKL'lere dayalı sonuçlar döndürüyorsa (sonuçlar herkese açık değilse) Office 365 hesabınızdan kullanıcı ve grupları okumak için kimlik bilgileri oluşturun. Microsoft'un Azure Active Directory uygulaması oluşturma talimatlarını uygulayın. Uygulamayı ayarlarken:

    1. Uygulamaya "gcs-o365-identity-connector" gibi açıklayıcı bir ad verin.
    2. İzin ekleyin. Uygulama için "Group.Read.All" ve "User.Read.All" gereklidir.
    3. Bağlayıcı yapılandırmasında kullanmak için aşağıdaki bilgileri kaydedin:
      • Uygulama Kimliği
      • Kiracı
      • İstemci Gizli Anahtarı

1. Adım: SharePoint Online bağlayıcı yazılımını yükleme

  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/v1-0.0.3

  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-v1-0.0.3.zip installation-dir
$ cd installation-dir
$ unzip google-cloudsearch-sharepoint-connector-v1-0.0.3.zip
$ cd google-cloudsearch-sharepoint-connector-v1-0.0.3

2. adım: SharePoint Online bağlayıcı yapılandırma dosyasını oluşturma

  1. Bağlayıcı kurulumuyla aynı dizinde yeni bir dosya oluşturun ve dosyaya sharepoint-online-connector.config adını verin. Çok sayıda bağlayıcı örneği çalıştırmayı planlıyorsanız, bağlayıcıyı ayırt etmek için ada daha fazla ayrıntı ekleyin.

  2. Parametreleri, aşağıdaki örnekte olduğu gibi dosya içeriğine anahtar/değer çiftleri olarak ekleyin:

    ### SharePoint Online connector configuration ###

# Required parameters for data source access
api.sourceId=08ef8becd116faa4546b8ca2c84b2879
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

# Optional SharePoint List Item metadata parameters
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: SharePoint Online bağlayıcısı için günlük kaydını ayarlama

  1. Bağlayıcı ikili programını içeren dizinde logs adında bir klasör oluşturun.

  2. Aynı dizinde logging.properties adında bir Latin-1 kodlu dosya oluşturun ve aşağıdaki içeriği 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

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

Bu adım, arama sonuçlarına SharePoint Online 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 yeni bir dosya oluşturun ve bu dosyayı sharepoint-online-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 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

    Değerler, SharePoint Online 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.

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

Bu adım, arama sonuçlarına SharePoint Online kimlik tabanlı EKL'leri uygulamak için gereklidir. Bağlayıcıyı herkese açık EKL'lerle ayarlarsanız bu adımı atlayabilirsiniz.

  1. GitHub'dan bağlayıcı deposunu klonlayın.

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

  2. Bağlayıcının istenen sürümünü kontrol edin:

    $ git checkout tags/v1-0.0.3

  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-office-365-connector-v1-0.0.3.zip installation-dir
$ cd installation-dir
$ unzip google-cloudsearch-office-365-connector-v1-0.0.3.zip
$ cd google-cloudsearch-office-365-connector-v1-0.0.3

6. Adım: Office 365 Kimlik bağlayıcısını yapılandırma ve günlük kaydını ayarlama

  1. Kimlik bağlayıcısı kurulumuyla aynı dizinde yeni bir dosya oluşturun ve dosyaya o365-identity-connector.config adını verin.

  2. Parametreleri, aşağıdaki örnekte olduğu gibi dosya içeriğine anahtar/değer çiftleri olarak ekleyin. Not: Tüm parametreler zorunludur.

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

    Her parametrenin ayrıntılı açıklamaları için Office 365 Identity bağlayıcı yapılandırma referansı başlıklı makaleye bakın.

  3. Bağlayıcı ikili programını içeren dizinde logs adında bir klasör oluşturun.

  4. Aynı dizinde logging.properties adlı bir ASCII veya UTF-8 dosyası oluşturun ve aşağıdaki içeriği ekleyin:

    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. SharePoint Online bağlayıcısını başlatın

Aşağıdaki adımlarda, hem Office 365 hem de SharePoint site koleksiyonundaki ana hesapları Cloud Identity hizmetindeki kimliklerle eşlersiniz. Bu senkronizasyon, Office 365 Identity bağlayıcısı ve SharePoint Online kimlik bağlayıcısıyla yapılır.

Office 365 bağlayıcısı kullanıcıları ve grupları senkronize ettikten sonra, SharePoint site koleksiyonu gruplarını senkronize etmek için SharePoint Online kimlik bağlayıcısını çalıştırın. Ardından, sonuçları dizine eklemek ve Cloud Search kullanıcılarınıza sunmak için SharePoint Online bağlayıcısını çalıştırırsınız.

  1. 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. SharePoint Online kimlik bağlayıcısını çalıştırın:

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

  3. 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ı

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 Site Koleksiyonu için tam nitelikli alan adı sharepoint.server=http://yoursharepoint.example.com/

Zorunlu. Alan adı tam değilse bağlayıcı ana makinesinde DNS geçersiz kılmayı ayarlayın.
Yalnızca Site Koleksiyonu Modu sharepoint.siteCollectionOnly=true

Zorunlu. SharePoint Online için true değerini 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"dır.
Dağıtım Türü sharepoint.deploymentType=ONLINE

Zorunlu. SharePoint Online için değer her zaman "ONLINE"dır.

SharePoint Identity Eşlemesi

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

Zorunlu. SharePoint grup kimlik kaynağının Cloud Search kimlik kaynağı kimliği.
Referans Kimliği Kaynakları api.referenceIdentitySources=defaultIdentitySource

Zorunlu. SharePoint Online için değer her zaman "defaultIdentitySource"tur.
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ğ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.

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

Office 365 Identity 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ğeriyle eşleşmelidir.
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 kurulumundaki 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 Uygulaması kurulumundan alınan kimlik bilgisi gizli anahtarı