نشر موصل Microsoft SharePoint Online

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

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

إعدادات Honored 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 بتعريفات المواقع.

  • عندما يصادف الموصل ملفات Microsoft Outlook. أثناء فهرسة المحتوى، يلغي نوع محتوى الملفات ويفهرسها كـ application/vnd.ms-outlook..

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

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

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

متطلبات النظام
نظام التشغيل
  • خادم Windows 2016
  • Ubuntu
  • الإصدار 5.0 من Red Hat Enterprise Linux
  • 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. إذا عرض الموصِّل النتائج استنادًا إلى قوائم التحكم بالوصول (ACLs) (النتائج ليست علنية)، على مشرف Google Workspace إنشاء مصدري هوية وتقديم أرقام التعريف الخاصة بهما:

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

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

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

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

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

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

الخطوة 1. تثبيت برنامج SharePoint Online Connector

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

  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.sourceId، تكون المعلَمة هي api.customerId. قيمة 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 وإعداد التسجيل

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

إعداد موصِّل Office 365 Identity

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

مطلوبة. رقم تعريف مصدر هوية Office 365 يجب أن تتطابق هذه القيمة مع قيمة "api.referenceIdentitySource.defaultIdentitySource.id" في إعدادات موصل SharePoint على الإنترنت.
رقم تعريف عميل 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