نشر موصل 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
  • الإصدار 5.0 من نظام التشغيل Red Hat Enterprise Linux
  • SUSE Enterprise Linux 10 (64 بت)
المصادقة
  • المصادقة المباشرة
البرامج
  • بيئة SharePoint Online
  • تم تثبيت الإصدار 1.8 من Java JRE على جهاز الكمبيوتر الذي سيشغِّل موصل Google Cloud Search SharePoint Online

نشر الموصِّل

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

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

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

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

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

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

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

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

  5. إذا أرجع الموصِّل نتائج استنادًا إلى قوائم التحكم في الوصول (النتائج ليست عامة)، فأنشئ بيانات اعتماد لقراءة المستخدمين والمجموعات من حساب 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. انسخ الملف المضغوط للموصل إلى دليل التثبيت المحلي:

    $ 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. أنشئ مجلدًا باسم السجلات في الدليل نفسه الذي يحتوي على البرنامج الثنائي للموصل.

  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 على نتائج البحث. إذا تم إعداد الموصل باستخدام قوائم التحكم في الوصول العامة، فيمكنك تخطي هذه الخطوة.

  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 Identity

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

  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. انسخ الملف المضغوط للموصل إلى دليل التثبيت المحلي:

    $ 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 Identity وإعداد التسجيل

  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 Identity.

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

  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 Identity وموصل هوية SharePoint Online.

بعد مزامنة موصِّل Office 365 للمستخدمين والمجموعات، يمكنك تشغيل موصِّل الهوية في SharePoint Online، لمزامنة مجموعات مجموعات المواقع الإلكترونية في SharePoint. وبعد ذلك، يمكنك تشغيل موصِّل SharePoint على الإنترنت لفهرسة النتائج وعرضها لمستخدمي 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 على الإنترنت

الإعدادات المعلمة
اسم النطاق المؤهّل بالكامل لمجموعة المواقع الإلكترونية على 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، تكون القيمة دائمًا "مباشر".
نوع النشر sharepoint.deploymentType=ONLINE

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

ربط هوية SharePoint

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

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

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

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

إنشاء محتوى 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 يتضمن جميع الحقول، بما في ذلك الحقول التي لم يتم ضبطها على مستوى جودة (مرتفع أو متوسط أو منخفض).
  • IGNORE - ينشئ الموصل محتوى 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