نشر موصل Microsoft SharePoint Online

يمكنك إعداد Google Cloud Search لعرض نتائج من محتوى SharePoint Online الخاص بمؤسستك بالإضافة إلى محتوى Google Workspace. يمكنك استخدام موصِّل Google Cloud Search SharePoint Online وضبطه ل الوصول إلى مصدر بيانات معيّن في SharePoint Online.

اعتبارات مهمة

إعدادات SharePoint المُحترمة

يراعي موصّل Cloud Search SharePoint Online دائمًا إعداد مستوى الوصول إلى البحث في SharePoint، ولا يمكن إلغاء هذا الإعداد. بالنسبة إلى مسودات المستندات، تتحكّم الأذونات في حساب المستخدم (التي يستخدمها الموصّل للوصول إلى SharePoint Online) في مسودات المستندات التي يتم فهرستها وإعادتها. إذا كان الحساب يتضمّن أذونات "القراءة الكاملة" فقط، سيلتزم الموصّل بإعدادات "مستوى رؤية مسودة العنصر" على SharePoint.

يمكنك أيضًا ضبط أداة الربط للحد من النتائج استنادًا إلى إمكانية الوصول إلى حساب المستخدم. لتطبيق ميزة "القطع وفقًا لمستوى الأمان" على محتوى SharePoint، عليك مزامنة الهويات الخارجية التالية مع "دليل Google":

  • مستخدمو Office 365 أو Azure AD
  • مجموعات الأمان في Office 365 أو Azure AD
  • مجموعات SharePoint (التي تتضمّن مستخدمي Office 365 والمجموعات كأعضاء)

تحسين الأداء على شبكة البحث

يمكنك تحسين تجربة المستخدمين من خلال ضبط الموصّل لعرض نتائج بحث أكثر صلة.

لاستخدام واجهة برمجة التطبيقات، اضبط قيمًا لمَعلمات إنشاء HTML في ملف إعدادات محوِّل SharePoint Online. تتيح لك هذه المَعلمات ضبط الحقول التي يكون لها تأثير أكبر أو أقل في المطابقات.

لإعداد مخطّط، اتّبِع التعليمات الواردة في مقالة إنشاء مخطّط وتسجيله. عند إعداد مخطّط:

  • لربط أسماء أنواع محتوى SharePoint بتعريفات العناصر المقابلة، يُعدِّل الموصّل أسماء أنواع المحتوى عن طريق استبعاد الأحرف غير المتوافقة. بالنسبة إلى تعريفات العناصر، لا تتيح Cloud Search API سوى الأحرف A-Z وa-z و0-9 كأحرف صالحة. على سبيل المثال، يتمّ ربط نوع المحتوى "الإشعارات" بتعريف العنصر "الإشعارات". يتمّ ربط نوع المحتوى "مقالة إخبارية" بـ "NewsArticle" (بدون مسافة).

  • عندما يتعذّر على الموصّل مطابقة تعريف كائن مع تعريف كائن آخر، يستخدم الموصّل نوع الكائن الاحتياطي (itemMetadata.objectType). اطّلِع على مزيد من المعلومات عن مَعلمات إعداد البيانات الوصفية.

  • يربط الموصّل أسماء مواقع SharePoint بتعريفات المواقع.

  • عندما يصادف الموصّل ملفات ‎ .msg من Microsoft Outlook أثناء فهرسة المحتوى، يتجاوز نوع المحتوى الخاص بالملفات ويفهرسها على أنّها application/vnd.ms-outlook.

القيود المعروفة للموصّلات

  • يمكن لكل مثيل من الموصّل فهرسة المحتوى من مجموعة مواقع إلكترونية واحدة فقط. لفهرسة مجموعات مواقع إلكترونية متعددة، عليك إعداد مثيلات إضافية للرابط.
  • يزداد استهلاك الذاكرة مع عدد المستخدمين والمجموعات الفريدة التي تستخدمها في جداول أذونات الوصول لكل مجموعة مواقع إلكترونية.
  • لا يتم حذف الإشعارات على الفور، وقد يستغرق الأمر أكثر من 4 ساعات حتى يرصد الموصِّل أنّ أحد المستخدمين حذف محتوى من مستودع المصدر.

متطلبات النظام

متطلبات النظام
نظام التشغيل
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 بت)
المصادقة
  • المصادقة المباشرة
البرامج
  • بيئة SharePoint Online
  • تثبيت Java JRE 1.8 على جهاز الكمبيوتر الذي سيتم تشغيل موصل Google Cloud Search SharePoint Online عليه

نشر الموصّل

المتطلبات الأساسية

  1. أنشئ مفتاحًا خاصًا في Google Workspace يحتوي على رقم تعريف حساب الخدمة. للتعرّف على كيفية الحصول على مفتاح خاص، انتقِل إلى مقالة ضبط أذونات الوصول إلى Google Cloud Search API.

  2. على مشرف Google Workspace إضافة مصدر بيانات للبحث. سجِّل رقم تعريف مصدر البيانات.

  3. إذا كان الموصِّل يعرض النتائج استنادًا إلى قوائم التحكّم في الوصول (النتائج ليست علنية)، على مشرف Google Workspace إنشاء مصدرَي هوية ومنحك معرّفَيهما:

    • واحد لمستخدمي Office 365 والمجموعات
    • واحد لمجموعات SharePoint

    على المشرف أيضًا الحصول على رقم تعريف عميل Google Workspace لمؤسستك وإعطاؤه لك.

    تعرَّف على كيفية الحصول على هذه القيم في مقالة ربط هويات المستخدمين في Cloud Search.

  4. إعداد حساب مستخدم لرابط البيانات الذي يمتلك امتيازات مشرف مجموعة مواقع SharePoint Online

  5. إذا كان الموصّل يعرض النتائج استنادًا إلى قوائم التحكّم في الوصول (ACLs) (النتائج ليست علنية)، أنشئ بيانات اعتماد لقراءة المستخدمين والمجموعات من حسابك على Office 365. اتّبِع تعليمات Microsoft لإنشاء تطبيق Azure Active Directory. أثناء إعداد التطبيق:

    1. أدخِل اسمًا وصفيًا للتطبيق، مثل "gcs-o365-identity-connector".
    2. أضِف الأذونات. يحتاج التطبيق إلى "Group.Read.All" و "User.Read.All".
    3. سجِّل المعلومات التالية لاستخدامها في إعداد الموصّل:
      • معرِّف التطبيق
      • المستأجر
      • سرّ العميل

الخطوة 1: تثبيت برنامج "موصّل SharePoint Online"

  1. استنسِخ مستودع الموصِّل من GitHub.

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

  2. اطّلِع على الإصدار المطلوب من الموصّل:

    $ git checkout tags/v1-0.0.3

  3. أنشئ الموصّل.

    $ mvn package

    لتخطّي الاختبارات عند إنشاء الموصِّل، شغِّل mvn package -DskipTests بدلاً من mvn package.

  4. انسخ ملف zip الخاص بالموصّل إلى دليل التثبيت على الجهاز:

    $ 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: إنشاء ملف إعدادات موصِّل SharePoint Online

  1. في الدليل نفسه الذي تم فيه تثبيت الموصّل، أنشئ ملفًا جديدًا واسمه sharepoint-online-connector.config. إذا كنت تخطّط لتشغيل العديد من نُسخ الموصّل، أضِف المزيد من التفاصيل إلى الاسم لتمييزه.

  2. أضِف المَعلمات كأزواج مفتاح/قيمة إلى محتوى الملف، كما هو موضّح في المثال التالي:

    ### 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

    للحصول على أوصاف تفصيلية لكل مَعلمة، انتقِل إلى مرجع مَعلمات الضبط.

  3. (اختياري) اضبط مَعلمات إضافية للموصّل حسب الحاجة. لمعرفة التفاصيل، انتقِل إلى مَعلمات الموصِّل المقدَّمة من Google.

الخطوة 3: إعداد التسجيل لموصّل SharePoint Online

  1. أنشئ مجلدًا باسم logs في الدليل نفسه الذي يحتوي على الملف الثنائي للموصّل.

  2. أنشئ ملفًا بترميز Latin-1 باسم logging.properties في الدليل نفسه وأضِف المحتوى التالي:

    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. ضبط موصّل هوية SharePoint Online

هذه الخطوة مطلوبة لتطبيق قوائم التحكّم في الوصول المستندة إلى الهوية في SharePoint Online على نتائج البحث. إذا أعددت الموصّل باستخدام قوائم التحكّم في الوصول (ACL) العامة، يمكنك تخطّي هذه الخطوة.

  1. في الدليل نفسه الذي تم فيه تثبيت موصّل SharePoint Online، أنشئ ملفًا جديدًا واسمه sharepoint-online-identity-connector.config.

  2. أضِف المَعلمات كأزواج مفتاح/قيمة إلى محتوى الملف، كما هو موضّح في المثال التالي:

    ### 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

    تتطابق القيم تقريبًا مع قيم موصل SharePoint Online، باستثناء أنّ المَعلمة هي api.customerId بدلاً من api.sourceId. قيمة api.customerId هي رقم تعريف العميل الذي حصلت عليه من مشرف Google Workspace.

الخطوة الخامسة. تثبيت "موصِّل هوية Office 365"

هذه الخطوة مطلوبة لتطبيق قوائم التحكّم في الوصول المستندة إلى الهوية في SharePoint Online على نتائج البحث. إذا أعددت الموصّل باستخدام قوائم التحكّم في الوصول (ACL) العامة، يمكنك تخطّي هذه الخطوة.

  1. استنسِخ مستودع الموصِّل من GitHub.

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

  2. اطّلِع على الإصدار المطلوب من الموصّل:

    $ git checkout tags/v1-0.0.3

  3. أنشئ الموصّل.

    $ mvn package

    لتخطّي الاختبارات عند إنشاء الموصِّل، شغِّل mvn package -DskipTests بدلاً من mvn package.

  4. انسخ ملف zip الخاص بالموصّل إلى دليل التثبيت على الجهاز:

    $ 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

الخطوة السادسة. ضبط "موصّل هوية Office 365" وإعداد التسجيل

  1. في الدليل نفسه الذي تم فيه تثبيت أداة ربط الهوية، أنشئ ملفًا جديدًا واسمه o365-identity-connector.config.

  2. أضِف المَعلمات كأزواج مفتاح/قيمة إلى محتوى الملف، كما هو موضّح في المثال التالي. ملاحظة: جميع المَعلمات مطلوبة.

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

    للحصول على أوصاف تفصيلية لكل مَعلمة، انتقِل إلى مرجع إعداد "موصِّل هوية Office 365".

  3. أنشئ مجلدًا باسم logs في الدليل نفسه الذي يحتوي على الملف الثنائي للموصّل.

  4. أنشئ ملفًا بترميز ASCII أو UTF-8 باسم logging.properties في الدليل نفسه وأضِف المحتوى التالي:

    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

الخطوة السابعة: تشغيل محوِّل SharePoint Online

في الخطوات التالية، يمكنك ربط المستخدمين الأساسيين في كلّ من Office 365 ومجموعة مواقع SharePoint بهويات في خدمة Cloud Identity. وتتم هذه المزامنة باستخدام موصِّل هوية Office 365 وموصِّل هوية SharePoint Online.

بعد أن يُجري محوِّل Office 365 عملية مزامنة للمستخدمين والمجموعات، يمكنك تشغيل محوِّل هوية SharePoint Online لمزامنة مجموعات مجموعات مواقع SharePoint. بعد ذلك، يمكنك تشغيل أداة ربط SharePoint Online لفهرسة النتائج وعرضها لمستخدمي Cloud Search.

  1. شغِّل "موصِّل هوية Office 365":

    $ 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:

    $ 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:

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

مرجع مَعلمات الإعدادات

الوصول إلى مصدر البيانات

الإعدادات المَعلمة
معرّف مصدر البيانات api.sourceId=1234567890abcdef

مطلوب. رقم تعريف مصدر بيانات Google Cloud Search الذي أعدّه مشرف Google Workspace
مسار ملف المفتاح الخاص لحساب الخدمة api.serviceAccountPrivateKeyFile=PrivateKey.json

مطلوب. المسار إلى ملف مفتاح حساب الخدمة في Google Cloud Search

الوصول إلى SharePoint Online

الإعدادات المَعلمة
اسم النطاق المؤهَّل بالكامل لمجموعة مواقع SharePoint sharepoint.server=http://yoursharepoint.example.com/

مطلوب. إذا لم يكن اسم النطاق مؤهَّلاً بالكامل، عليك ضبط إعدادات إلغاء نظام أسماء النطاقات على مضيف الموصّل.
وضع "مجموعة المواقع الإلكترونية فقط" sharepoint.siteCollectionOnly=true

مطلوب. بالنسبة إلى SharePoint Online، اضبط القيمة على true.
اسم مستخدم SharePoint sharepoint.username=username

مطلوب. اسم مستخدم الحساب المستخدَم للوصول إلى SharePoint Online.
كلمة مرور SharePoint sharepoint.password=user_password

مطلوب. كلمة مرور الحساب المستخدَم للوصول إلى SharePoint Online.
وضع المصادقة sharepoint.formsAuthenticationMode=LIVE

مطلوب. بالنسبة إلى SharePoint Online، تكون القيمة دائمًا "LIVE".
نوع النشر sharepoint.deploymentType=ONLINE

مطلوب. بالنسبة إلى SharePoint Online، تكون القيمة دائمًا "ONLINE".

تعيين الهوية في SharePoint

الإعدادات المَعلمة
رقم تعريف مصدر الهوية api.identitySourceId=1234567890abcdef

مطلوب. رقم تعريف مصدر الهوية في Cloud Search لمصدر هوية مجموعات SharePoint
مصادر الهوية المرجعية api.referenceIdentitySources=defaultIdentitySource

مطلوب. بالنسبة إلى SharePoint Online، تكون القيمة دائمًا defaultIdentitySource.
أرقام تعريف مصادر الهوية المرجعية api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

مطلوب. رقم تعريف مصدر الهوية في Cloud Search لمصدر هوية مستخدمي ومجموعات Office 365

إنشاء محتوى HTML

الإعدادات المَعلمة
حقل عنوان نموذج HTML contentTemplate.sharePointItem.title=Title

حقل SharePoint الذي سيتم استخدامه كعنوان نموذج HTML لرمز HTML الذي تم إنشاؤه.
حقول جودة البحث العالية لمحتوى HTML contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

قائمة مفصولة بفواصل للحقول المطلوب تضمينها في ملف HTML الذي تم إنشاؤه كحقول عالية الجودة عندما تتطابق عبارات طلب البحث مع هذه الحقول، يتم ترتيب النتائج في مراتب أعلى.
حقول جودة البحث المتوسط لمحتوى HTML contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

قائمة مفصولة بفواصل للحقول المطلوب تضمينها في ملف HTML الذي تم إنشاؤه كحقول ذات جودة متوسطة
حقول جودة البحث المنخفضة لمحتوى HTML contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

قائمة مفصولة بفواصل بالحقول المطلوب تضمينها في ملف HTML الذي تم إنشاؤه كحقول ذات جودة منخفضة
الأعمدة غير المُعرَّفة لمحتوى HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

كيفية تعامل الموصِّل مع الأعمدة غير المُحدَّدة القيمة هي APPEND (التلقائية) أو IGNORE.

  • APPEND: ينشئ الموصّل محتوى HTML يتضمّن جميع الحقول، بما في ذلك الحقول التي لم يتم ضبطها بمستوى جودة (مرتفع أو متوسط أو منخفض).
  • تجاهل: ينشئ الموصّل محتوى HTML باستخدام الحقول المرتبطة فقط.

إعدادات "موصِّل الهوية" في Office 365

الإعدادات المَعلمة
رقم تعريف مصدر الهوية api.identitySourceId=1234567890abcdef

مطلوب. رقم تعريف مصدر الهوية في Office 365 يجب أن تتطابق هذه القيمة مع قيمة api.referenceIdentitySource.defaultIdentitySource.id في إعدادات محوِّل SharePoint Online.
رقم تعريف العميل في Google api.customerId=c1b1d1e1

مطلوب. الرقم التعريفي لعميل Google Workspace في مؤسستك
معرّف تطبيق Office 365 o365.clientId=a63c6eb3-29e7-486

مطلوب. معرّف التطبيق من عملية إعداد تطبيق Office 365

مستأجر Office 365 o365.tenant=185ef9ed-29e7-486

مطلوب. مستأجر حسابك على Office 365 (تطبيق Azure Activity Directory)
سر العميل في Office 365 o365.clientSecret=raHJN15vRLBKs

مطلوب. الحصول على سرّ بيانات الاعتماد من عملية إعداد تطبيق Office 365