رابط Microsoft SharePoint Online را مستقر کنید

شما می‌توانید Google Cloud Search را طوری تنظیم کنید که علاوه بر محتوای Google Workspace، نتایج محتوای SharePoint Online سازمان شما را نیز برگرداند. از رابط Cloud Search SharePoint Online استفاده کنید و آن را برای دسترسی به یک منبع داده SharePoint Online خاص پیکربندی کنید.

ملاحظات مهم

قبل از استقرار رابط SharePoint Online، از ملاحظات زیر آگاه باشید.

تنظیمات SharePoint ارجمند

رابط همیشه تنظیمات قابلیت مشاهده جستجو در SharePoint را رعایت می‌کند. برای اسناد پیش‌نویس، مجوزهای حساب کاربری که رابط برای دسترسی به کنترل SharePoint Online استفاده می‌کند، اسناد پیش‌نویس را فهرست‌بندی و برمی‌گرداند. اگر حساب فقط مجوزهای "خواندن کامل" را داشته باشد، رابط تنظیمات "قابلیت مشاهده آیتم پیش‌نویس" را رعایت می‌کند.

همچنین می‌توانید کانکتور را طوری پیکربندی کنید که نتایج را بر اساس دسترسی به حساب کاربری محدود کند. برای اعمال تنظیمات امنیتی، این هویت‌های خارجی را با Google Cloud Directory همگام‌سازی کنید:

  • کاربران آفیس ۳۶۵ / Azure AD.
  • گروه‌های امنیتی آفیس ۳۶۵ / آژور AD.
  • گروه‌های SharePoint (با کاربران و گروه‌های Office 365 به عنوان عضو).

بهینه‌سازی جستجو

با پیکربندی رابط برای بازگرداندن نتایج مرتبط، تجربه جستجو را بهبود بخشید. از پارامترهای تولید HTML در فایل پیکربندی برای تنظیم سطوح تأثیر فیلد استفاده کنید.

برای تنظیم یک طرحواره، به بخش ایجاد و ثبت طرحواره مراجعه کنید. هنگام تنظیم یک طرحواره:

  • این رابط، انواع محتوای SharePoint را به نام‌های تعریف شیء معتبر (AZ، az، 0-9) نرمال‌سازی می‌کند. برای مثال، "News Article" به "NewsArticle" تبدیل می‌شود.
  • اگر کانکتور نتواند با تعریف یک شیء مطابقت داشته باشد، از نوع شیء جایگزین ( itemMetadata.objectType ) استفاده می‌کند. به پارامترهای پیکربندی Metadata مراجعه کنید.
  • این رابط، نام‌های ویژگی‌های SharePoint را به تعاریف ویژگی‌ها نگاشت می‌کند.
  • این رابط، نوع رسانه را برای فایل‌های .msg مایکروسافت اوت‌لوک نادیده می‌گیرد و آن‌ها را به صورت application/vnd.ms-outlook فهرست‌بندی می‌کند.

محدودیت‌های شناخته‌شده‌ی کانکتور

  • هر نمونه کانکتور، محتوای فقط یک مجموعه سایت را ایندکس می‌کند. برای ایندکس کردن چندین مجموعه سایت، نمونه‌های اضافی راه‌اندازی کنید.
  • مصرف حافظه با افزایش تعداد کاربران و گروه‌های منحصر به فرد در ACLها افزایش می‌یابد.
  • انتشار اعلان‌های حذف می‌تواند بیش از ۴ ساعت طول بکشد.

الزامات سیستم

الزامات سیستم
سیستم عامل ویندوز سرور ۲۰۱۶، اوبونتو، رد هت انترپرایز لینوکس ۵.۰ یا سوزه انترپرایز لینوکس ۱۰ (۶۴ بیتی).
احراز هویت احراز هویت زنده
نرم‌افزار محیط SharePoint Online؛ جاوا JRE 1.8.

کانکتور را مستقر کنید

برای نصب و راه اندازی SharePoint Online Connector مراحل زیر را دنبال کنید.

پیش‌نیازها

  1. یک کلید خصوصی Google Workspace ایجاد کنید. به پیکربندی دسترسی به Cloud Search API مراجعه کنید.
  2. یک منبع داده برای جستجو اضافه کنید و شناسه آن را ثبت کنید. به بخش «افزودن یک منبع داده برای جستجو» مراجعه کنید.
  3. برای نتایج مبتنی بر ACL، سرپرست شما باید دو منبع هویت (یکی برای آفیس ۳۶۵ و یکی برای گروه‌های SharePoint) ایجاد کند و شناسه مشتری Google Workspace را ارائه دهد. به نگاشت هویت‌های کاربر مراجعه کنید.
  4. یک حساب کاربری برای رابط با امتیازات مدیر مجموعه سایت‌های آنلاین SharePoint تنظیم کنید.
  5. اعتبارنامه‌های برنامه Azure Active Directory را با مجوزهای Group.Read.All و User.Read.All ایجاد کنید. شناسه برنامه، مستاجر و رمز کلاینت را یادداشت کنید.

مرحله 1. نرم‌افزار کانکتور را نصب کنید

  1. مخزن را کلون کنید: 
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
$ cd sharepoint-connector
  2. نسخه انتخابی خود را بررسی کنید (مثلاً v1-0.0.3 ): 
    $ git checkout tags/v1-0.0.3
  3. کانکتور را بسازید:
    $ mvn package
     برای رد کردن تست‌ها، از mvn package -DskipTests استفاده کنید.
  4. فایل زیپ را در پوشه نصب خود استخراج کنید.

مرحله ۲. ایجاد فایل پیکربندی

sharepoint-online-connector.config در پوشه نصب ایجاد کنید. پارامترها را به صورت جفت‌های کلید-مقدار، همانطور که در مثال زیر نشان داده شده است، اضافه کنید:

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

برای جزئیات بیشتر به مرجع یا پارامترهای ارائه شده توسط گوگل مراجعه کنید.

مرحله 3. تنظیم گزارش‌گیری

یک پوشه‌ی logs و یک فایل 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

مرحله ۴. پیکربندی رابط هویت SharePoint

برای اعمال ACL های مبتنی بر هویت، sharepoint-online-identity-connector.config را با api.customerId و سایر پارامترهای اتصال خود مانند مثال زیر ایجاد کنید:

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

مرحله ۵. رابط هویت آفیس ۳۶۵ را نصب کنید

اگر از ACL های مبتنی بر هویت SharePoint Online استفاده می‌کنید، این مرحله را انجام دهید. اگر از ACL های عمومی استفاده می‌کنید، از این مرحله صرف نظر کنید.

  1. مخزن آفیس ۳۶۵ را کلون کنید:

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

  2. بررسی کنید و با استفاده از mvn package کانکتور را بسازید.

  3. فایل زیپ را در پوشه نصب خود استخراج کنید.

مرحله ۶. پیکربندی رابط هویت آفیس ۳۶۵

  1. در همان دایرکتوری که کانکتور هویت نصب شده است، فایلی با نام o365-identity-connector.config ایجاد کنید و پارامترها را به صورت جفت‌های کلید-مقدار اضافه کنید:

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

    برای توضیحات پارامترها، به رابط هویت آفیس ۳۶۵ مراجعه کنید.

  2. در همان دایرکتوری، پوشه‌ای با نام logs ایجاد کنید.

  3. در همان دایرکتوری، فایلی با نام 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

مرحله 7. اتصال را راه اندازی کنید

پس از پیکربندی کانکتورها، آنها را اجرا کنید تا همگام‌سازی و فهرست‌بندی شروع شود. هر دستور را در پنجره ترمینال مخصوص به خود اجرا کنید.

  1. برای همگام‌سازی کاربران و گروه‌ها، رابط هویت آفیس ۳۶۵ را اجرا کنید: 

    $ 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 -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -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

مرجع پارامترهای پیکربندی

بخش‌های زیر پارامترهای پیکربندی مورد استفاده برای پیکربندی رابط SharePoint Online را فهرست می‌کنند.

دسترسی به منبع داده

تنظیم پارامتر
شناسه منبع داده api.sourceId= 1234567890abcdef

الزامی. شناسه منبع داده جستجوی ابری گوگل که توسط مدیر Google Workspace تنظیم شده است.

مسیر فایل کلید خصوصی حساب کاربری سرویس api.serviceAccountPrivateKeyFile= PrivateKey.json

الزامی. مسیر فایل کلید حساب سرویس جستجوی ابری گوگل.

دسترسی آنلاین به شیرپوینت

تنظیم پارامتر
نام دامنه کاملاً واجد شرایط برای مجموعه سایت‌های SharePoint sharepoint.server= http://yoursharepoint.example.com/

الزامی. اگر نام دامنه کاملاً واجد شرایط نیست، DNS override را روی میزبان کانکتور تنظیم کنید.

حالت فقط جمع‌آوری سایت sharepoint.siteCollectionOnly=true

الزامی. برای SharePoint Online، مقدار را true قرار دهید.

نام کاربری شیرپوینت sharepoint.username= username

الزامی. نام کاربری حساب کاربری که برای دسترسی به SharePoint Online استفاده می‌شود.

رمز عبور شیرپوینت sharepoint.password= user_password

الزامی. رمز عبور حساب کاربری مورد استفاده برای دسترسی به SharePoint Online.

حالت احراز هویت sharepoint.formsAuthenticationMode=LIVE

الزامی. برای SharePoint Online، مقدار همیشه «LIVE» است.

نوع استقرار sharepoint.deploymentType=ONLINE

الزامی. برای SharePoint Online، مقدار همیشه `ONLINE` است.

نگاشت هویت شیرپوینت

تنظیم پارامتر
شناسه منبع هویت api.identitySourceId= 1234567890abcdef

الزامی. شناسه منبع هویت Cloud Search برای منبع هویت گروه‌های SharePoint.

منابع هویت مرجع api.referenceIdentitySources=defaultIdentitySource

الزامی. برای شیرپوینت آنلاین، مقدار همیشه `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 است.

  • ضمیمه - رابط، محتوای HTML را با تمام فیلدها، از جمله فیلدهایی که با سطح کیفیت (بالا، متوسط ​​یا پایین) تنظیم نشده‌اند، تولید می‌کند.
  • نادیده گرفتن - رابط، محتوای HTML را فقط با فیلدهای نگاشت‌شده تولید می‌کند.

پیکربندی رابط هویت آفیس ۳۶۵

تنظیم پارامتر
شناسه منبع هویت api.identitySourceId= 1234567890abcdef

الزامی. شناسه منبع هویت آفیس ۳۶۵. این مقدار باید با مقدار `api.referenceIdentitySource.defaultIdentitySource.id` در پیکربندی کانکتور SharePoint Online مطابقت داشته باشد.

شناسه مشتری گوگل api.customerId= c1b1d1e1

الزامی. شناسه مشتری Google Workspace سازمان شما.

شناسه برنامه آفیس ۳۶۵ o365.clientId= a63c6eb3-29e7-486

الزامی. شناسه برنامه از تنظیمات برنامه آفیس ۳۶۵.

مستاجر آفیس ۳۶۵ o365.tenant= 185ef9ed-29e7-486

الزامی. مستأجر حساب آفیس ۳۶۵ شما (برنامه Azure Activity Directory شما)

راز کلاینت آفیس ۳۶۵ o365.clientSecret= raHJN15vRLBKs

الزامی. رمز عبور از تنظیمات برنامه آفیس ۳۶۵