פריסת המחבר של 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 כחברים)

אופטימיזציה של חיפוש

אפשר לשפר את חוויית המשתמשים על ידי הגדרת המחבר כך שיחזיר תוצאות חיפוש רלוונטיות יותר.

כדי להשתמש ב-API, צריך להגדיר ערכים לפרמטרים ליצירת HTML בקובץ התצורה של מחבר SharePoint Online. הפרמטרים האלה מאפשרים להגדיר אילו שדות משפיעים יותר או פחות על ההתאמות.

כדי להגדיר סכימה, צריך לפעול לפי ההוראות במאמר יצירה ורישום של סכימה. כשמגדירים סכימה:

  • כדי למפות שמות של סוגי תוכן של SharePoint להגדרות תואמות של אובייקטים, המחבר מנרמל את השמות של סוגי התוכן על ידי החרגת תווים שאינם נתמכים. להגדרות של אובייקטים, Cloud Search API תומך רק בתווים A-Z, a-z ו-0-9 כתווים חוקיים. לדוגמה, סוג התוכן 'הודעות' ממופה להגדרת האובייקט 'הודעות'. סוג התוכן 'כתבה חדשותית' ממופה ל-NewsArticle (ללא מקום).

  • כאשר המחבר לא יכול להתאים להגדרת אובייקט עם הגדרת אובייקט, המחבר משתמש בסוג האובייקט החלופי (itemMetadata.objectType). מידע נוסף על פרמטרים של הגדרת מטא-נתונים.

  • המחבר ממפה את שמות המאפיינים של SharePoint להגדרות הנכס.

  • כשהמחבר נתקל בקובצי .msg של Microsoft Outlook בזמן שהוא מוסיף תוכן לאינדקס, הוא מבטל את סוג התוכן של הקבצים ומוסיף אותם לאינדקס בתור application/vnd.ms-outlook.

מגבלות ידועות של המחבר

  • כל מופע של מחבר יכול להוסיף תוכן לאינדקס מאוסף אתרים אחד בלבד. כדי להוסיף מספר אוספים של אתרים לאינדקס, צריך להגדיר מופעי מחברים נוספים.
  • צריכת הזיכרון הולכת וגדלה ככל שמספר המשתמשים והקבוצות הייחודיים שבהם משתמשים ברשימות ACL עבור כל אוסף אתרים.
  • מחיקת התראות לא מתבצעת באופן מיידי ויכולות לחלוף יותר מ-4 שעות עד שהמחבר יזהה שמשתמש מחק תוכן ממאגר המקור.

דרישות המערכת

דרישות המערכת
מערכת הפעלה
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • 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. אם המחבר מחזיר תוצאות על סמך רשימות ACL (התוצאות לא גלויות לכולם), האדמין ב-Google Workspace צריך ליצור שני מקורות זהות ולתת לכם את המזהים שלהם:

    • אחד למשתמשים ולקבוצות ב-Office 365
    • אחת לקבוצות SharePoint

    האדמין צריך גם לקבל את מספר הלקוח של הארגון ב-Google Workspace ולתת לכם אותו.

    כך מקבלים את הערכים האלה במאמר מיפוי זהויות משתמשים ב-Cloud Search.

  4. להגדיר חשבון משתמש למחבר שיש לו הרשאות אדמין לאוסף אתרים ב-SharePoint.

  5. אם המחבר מחזיר תוצאות המבוססות על רשימות ACL (התוצאות אינן ציבוריות), צריך ליצור פרטי כניסה כדי לקרוא משתמשים וקבוצות מחשבון Office 365. פועלים לפי ההוראות של Microsoft כדי ליצור אפליקציה של Azure Active Directory. בזמן הגדרת האפליקציה:

    1. נותנים לאפליקציה שם תיאורי, כמו gcs-o365-identity-connector.
    2. מוסיפים הרשאות. האפליקציה צריכה את ההרשאות 'Group.Read.All' ו-'User.Read.All'.
    3. מתעדים את הפרטים הבאים לשימוש בהגדרות האישיות של המחבר:
      • מזהה האפליקציה
      • דייר (tenant)
      • סוד לקוח

שלב 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. הגדרת רישום ביומן למחבר 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

השלב הזה נדרש כדי להחיל רשימות 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

השלב הזה נדרש כדי להחיל רשימות 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 והגדרת רישום ביומן

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

  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 ועם מחבר הזהויות של 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/

חובה. אם שם הדומיין לא מוגדר במלואו, יש להגדיר 'שינוי DNS' במארח המחבר.
מצב 'איסוף אתרים בלבד' 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.

  • הוספה — המחבר יוצר תוכן 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