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

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

ملاحظات مهم

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

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

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

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

شما می‌توانید با پیکربندی رابط برای نمایش نتایج جستجوی مرتبط‌تر، تجربه کاربران خود را بهبود بخشید.

برای استفاده از API، مقادیر پارامترهای تولید HTML را در فایل پیکربندی کانکتور SharePoint Online تنظیم کنید. این پارامترها به شما امکان می‌دهند تعیین کنید کدام فیلدها تأثیر بیشتر یا کمتری روی تطابق‌ها داشته باشند.

برای تنظیم یک طرحواره، دستورالعمل‌های موجود در «ایجاد و ثبت طرحواره» را دنبال کنید. هنگام تنظیم یک طرحواره:

  • برای نگاشت نام انواع محتوای SharePoint به تعاریف شیء مربوطه، رابط با حذف کاراکترهای پشتیبانی نشده، نام‌های نوع محتوا را عادی‌سازی می‌کند. برای تعاریف شیء، Cloud Search API فقط از AZ، az و 0-9 به عنوان کاراکترهای معتبر پشتیبانی می‌کند. به عنوان مثال، نوع محتوای "Announcements" به تعریف شیء "Announcements" نگاشت می‌شود. نوع محتوای "News Article" به "NewsArticle" (بدون فاصله) نگاشت می‌شود.

  • وقتی رابط نمی‌تواند تعریف یک شیء را با تعریف شیء دیگری مطابقت دهد، رابط از نوع شیء جایگزین ( itemMetadata.objectType ) استفاده می‌کند. درباره پارامترهای پیکربندی فراداده بیشتر بدانید.

  • این رابط، نام‌های ویژگی‌های SharePoint را به تعاریف ویژگی‌ها نگاشت می‌کند.

  • وقتی رابط هنگام ایندکس کردن محتوا با فایل‌های .msg مایکروسافت اوت‌لوک مواجه می‌شود، نوع محتوای فایل‌ها را نادیده می‌گیرد و آنها را به صورت application/vnd.ms-outlook.

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

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

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

الزامات سیستم
سیستم عامل
  • ویندوز سرور ۲۰۱۶
  • اوبونتو
  • لینوکس رد هت انترپرایز ۵.۰
  • سوزه انترپرایز لینوکس ۱۰ (۶۴ بیتی)
احراز هویت
  • احراز هویت زنده
نرم‌افزار
  • محیط آنلاین شیرپوینت
  • جاوا JRE 1.8 نصب شده روی رایانه‌ای که رابط Google Cloud Search SharePoint Online را اجرا خواهد کرد

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

پیش‌نیازها

  1. یک کلید خصوصی Google Workspace ایجاد کنید که حاوی شناسه حساب سرویس شما باشد. برای آشنایی با نحوه دریافت کلید خصوصی، به پیکربندی دسترسی به API جستجوی ابری گوگل (Configure access to the Google Cloud Search API) بروید.

  2. مدیر Google Workspace شما باید یک منبع داده برای جستجو اضافه کند . شناسه منبع داده را ثبت کنید.

  3. اگر رابط نتایج را بر اساس ACLها (نتایج عمومی نیستند) برگرداند، مدیر Google Workspace شما باید دو منبع هویت ایجاد کند و شناسه‌های آنها را به شما بدهد:

    • یکی برای کاربران و گروه‌های آفیس ۳۶۵
    • یکی برای گروه‌های SharePoint

    مدیر همچنین باید شناسه مشتری Google Workspace سازمان شما را دریافت کرده و در اختیار شما قرار دهد.

    یاد بگیرید که چگونه این مقادیر را در Map user identity در Cloud Search دریافت کنید.

  4. یک حساب کاربری برای رابط تنظیم کنید که دارای امتیازات مدیر مجموعه سایت‌های آنلاین SharePoint باشد.

  5. اگر رابط نتایج را بر اساس ACLها برمی‌گرداند (نتایج عمومی نیستند)، برای خواندن کاربران و گروه‌ها از حساب Office 365 خود، اعتبارنامه ایجاد کنید. دستورالعمل‌های مایکروسافت را برای ایجاد یک برنامه Azure Active Directory دنبال کنید. هنگام تنظیم برنامه:

    1. نام برنامه را با یک نام توصیفی مانند "gcs-o365-identity-connector" انتخاب کنید.
    2. مجوزها را اضافه کنید. برنامه به "Group.Read.All" و "User.Read.All" نیاز دارد.
    3. اطلاعات زیر را برای استفاده در پیکربندی کانکتور ثبت کنید:
      • شناسه برنامه
      • مستأجر
      • راز مشتری

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

  1. مخزن کانکتور را از گیت‌هاب کپی کنید.

    $ 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 mvn package -DskipTests را اجرا کنید.

  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

مرحله ۲. فایل پیکربندی کانکتور 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. (اختیاری) در صورت نیاز، پارامترهای کانکتور اضافی را پیکربندی کنید. برای جزئیات بیشتر، به پارامترهای کانکتور ارائه شده توسط گوگل مراجعه کنید.

مرحله ۳. تنظیم گزارش‌گیری برای رابط 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

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

این مرحله برای اعمال ACL های مبتنی بر هویت 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.sourceId ، پارامتر api.customerId است. مقدار api.customerId ، شناسه مشتری است که از ادمین Google Workspace خود دریافت کرده‌اید.

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

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

  1. مخزن کانکتور را از گیت‌هاب کپی کنید.

    $ 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 mvn package -DskipTests را اجرا کنید.

  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

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

  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

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

  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 را اجرا کنید

در مراحل زیر، شما Principalها را در Office 365 و مجموعه سایت SharePoint به هویت‌های موجود در سرویس Cloud Identity نگاشت می‌کنید. این همگام‌سازی با رابط هویت Office 365 و رابط هویت SharePoint Online انجام می‌شود.

پس از اینکه رابط آفیس ۳۶۵ کاربران و گروه‌ها را همگام‌سازی کرد، رابط هویت SharePoint Online را اجرا کنید تا گروه‌های مجموعه سایت SharePoint را همگام‌سازی کنید. سپس رابط SharePoint Online را اجرا کنید تا نتایج را به کاربران Cloud Search خود فهرست‌بندی و ارائه دهید.

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

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