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

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

ملاحظات مهم

تنظیمات Honored SharePoint

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

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

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

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

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

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

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

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

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

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

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

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

سیستم مورد نیاز

سیستم مورد نیاز
سیستم عامل
  • ویندوز سرور 2016
  • اوبونتو
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 بیت)
احراز هویت
  • احراز هویت زنده
نرم افزار
  • محیط شیرپوینت آنلاین
  • جاوا JRE 1.8 روی رایانه نصب شده است که رابط Google Cloud Search SharePoint Online را اجرا می کند

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

پیش نیازها

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

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

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

    • یکی برای کاربران و گروه های Office 365
    • یکی برای گروه های شیرپوینت

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

    با نحوه دریافت این مقادیر در شناسه های کاربر Map در جستجوی ابری آشنا شوید.

  4. یک حساب کاربری برای کانکتوری که دارای امتیازات سرپرست SharePoint Online Site Collection است راه اندازی کنید.

  5. اگر کانکتور نتایج را بر اساس ACL ها برمی گرداند (نتایج عمومی نیستند)، اعتبارنامه هایی برای خواندن کاربران و گروه ها از حساب Office 365 خود ایجاد کنید. دستورالعمل های مایکروسافت را برای ایجاد یک برنامه 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. ورود به سیستم را برای اتصال شیرپوینت آنلاین تنظیم کنید

  1. پوشه ای به نام logs در همان دایرکتوری که حاوی کانکتور باینری است ایجاد کنید.

  2. یک فایل با کد لاتین-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 را پیکربندی کنید

این مرحله برای اعمال 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 خود دریافت کرده‌اید.

مرحله 5. رابط Office 365 Identity را نصب کنید

این مرحله برای اعمال ACLهای مبتنی بر هویت 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

مرحله 6. رابط کاربری 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 بروید.

  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

مرحله 7. کانکتور SharePoint Online را راه اندازی کنید

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

پس از اینکه رابط Office 365 کاربران و گروه‌ها را همگام‌سازی کرد، کانکتور هویت SharePoint Online را اجرا کنید تا گروه‌های مجموعه سایت شیرپوینت را همگام‌سازی کنید. سپس کانکتور SharePoint Online را اجرا می کنید تا نتایج را به کاربران جستجوی ابری خود فهرست کرده و ارائه دهید.

  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. اتصال شیرپوینت آنلاین را اجرا کنید: 

    $ 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 که توسط سرپرست Google Workspace تنظیم شده است.

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

مورد نیاز. مسیر فایل کلید حساب سرویس Google Cloud Search.

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

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

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

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

مورد نیاز. برای SharePoint Online، مقدار true را تنظیم کنید.

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

مورد نیاز. نام کاربری حساب مورد استفاده برای دسترسی به شیرپوینت آنلاین.

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

مورد نیاز. رمز عبور حساب مورد استفاده برای دسترسی به شیرپوینت آنلاین.

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

مورد نیاز. برای شیرپوینت آنلاین، مقدار همیشه "LIVE" است.

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

مورد نیاز. برای شیرپوینت آنلاین، مقدار همیشه «ONLINE» است.

نقشه‌برداری هویت شیرپوینت

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

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

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

مورد نیاز. برای SharePoint Online، مقدار همیشه «defaultIdentitySource» است.

شناسه های منبع هویت مرجع api.referenceIdentitySource.defaultIdentitySource.id= 112233abcd

مورد نیاز. شناسه منبع هویت جستجوی ابری برای منبع هویت کاربران و گروه‌های آفیس 365.

تولید محتوای HTML

تنظیم پارامتر
فیلد عنوان قالب HTML contentTemplate.sharePointItem.title= Title

فیلد شیرپوینت برای استفاده به عنوان قالب 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