הצהרת אחריות

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

(ג) Nuix Canada Inc. 2024 כל הזכויות שמורות

מבוא

מדריך זה מתאר את ההתקנה של לְמַכֵּן. מסמך זה עובד כמו הפניה - השתמש בתוכן העניינים כדי לחפש את הנושא שעליו אתה מגלה.

תוכנת Automate והתיעוד הזה עשויים להכיל באגים, שגיאות או מגבלות אחרות. אם אתה נתקל בבעיות כלשהן בתוכנת Automate או בתיעוד זה, צור קשר עם תמיכת nuix.

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

התוכנה דורשת רישיון אוטומטי בתוקף. הרישיון הוא בדרך כלל מוגבל בזמן, ותכונות מסוימות של התוכנה דורשות מהדורת רישיון ספציפית. אם אתה נתקל בבעיות כלשהן עם רישיון האוטומציה, או לשאלות ספציפיות לגבי תכונת מוצר, אנא צור קשר עם תמיכת nuix.

סגנונות המשמשים במדריך זה

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

  • מודגש: סגנון זה מציין את שמו של תפריט, אפשרות או קישור.

  • code: סגנון זה מציין קוד שיש להשתמש בו באופן מילולי, ויכול להתייחס לנתיבי קבצים, שמות פרמטרים או שאילתות חיפוש של Nuix.

1. ארכיטקטורה

1.1. רכיבים

מספר רכיבים הם חלק מפריסה אוטומטית:

  • אוטומציה של מתזמן: מקבל בקשות מהאנליסטים או משירותי ארגונים לעבודות בתור ומשגר את העבודות לשרתים של Automate Engine.

  • אוטומציה של שרת מנוע: מקבל עבודות מ-Automate Scheduler, מפעיל מנועים ומפעיל עבודות.

  • מנוע Nuix: מנוע ה- Nuix יוצר / פותח תיקים של Nuix ומבצע את העבודות הנדרשות במקרים

  • מקור הרישיון של Nuix: ניתן להשתמש במקורות רישיון של Nuix אחד או יותר, מהסוגים הבאים:

    • Nuix NMS

    • רישיון Nuix Dongle

    • רישיון ענן של Nuix

  • מקור האימות: השירות שישמש לאימות משתמשים ולקביעת חברות בקבוצה. זה יכול להיות שילוב של הדברים הבאים:

    • Nuix UMS: שרת ניהול המשתמש של Nuix

    • LDAP: Active Directory מקומי ise

    • AD AD: Microsoft Active Directory Directory

    • OIDC: שירות אימות תואם Open ID Connect

    • פנימי: שמות משתמש וסיסמאות המוגדרים באופן פנימי, לתצורה ראשונית.

בנוסף, הרכיבים הבאים הם אופציונליים:

  • הפוך שרת OData לאוטומטי: מחזירה נתוני ניצול באמצעות פרוטוקול OData.

  • הפוך פרוקסי לאוטומטי: מוריד את העלאת הנתונים וה-hashing מה-Automate Scheduler הראשי.

  • תוכנת בינה עסקית: כלי תוכנה שמחפש מדדים בסביבת Automate, מנתח את הנתונים ומספק לוחות מחוונים אינטראקטיביים, כגון Microsoft Power BI או Tableau.

  • SQL של מיקרוסופט: ניתן להשתמש בה כדי להחליף את מסד הנתונים המובנה של מתזמן לאחסון יומני מידע, תצורה וביצוע ביקורת.

1.2. פריסה

למעט Automate Engine Server שצריך להתקין על כל שרת Nuix שיהווה חלק מהפריסה של Automate, ניתן לפרוס את כל הרכיבים הנותרים על אותו שרת או על שרתים ייעודיים.

בעת פריסת שרת האוטומטי OData האופציונלי בשרת שונה מהשרת המארח את Automate Scheduler, יש להפנות את נתוני הניצול ממסד הנתונים המוטבע למסד נתונים של Microsoft SQL.

1.2.1. אדריכלות מבוזרת לדוגמא

ארכיטקטורה לדוגמה זו מורכבת משרת ייעודי המארח את Automate Scheduler, מספר שרתים המארחים Automate Engine Servers ו- Nuix Engines, שרתים ייעודיים עבור Nuix NMS ו- Nuix UMS, וקישוריות עם Azure AD.

ארכיטקטורה מופצת לדוגמא

1.2.2. דוגמא לארכיטקטורה עצמאית

ארכיטקטורה לדוגמה זו מורכבת משרת יחיד המארח את Automate Scheduler ואת Automate Engine Server, מספר מנועים של Nuix, כמו גם את Nuix NMS ו- Nuix UMS.

דוגמה לארכיטקטורה עצמאית

1.3. זרימת תנועה ברשת

רכיבים בפריסה אוטומטית מתקשרים באמצעות HTTP. להגדרת תצורת יציאות TCP ותעודות TLS, עיין בסעיף Configuration.

זרימת תנועה
מקור יעד פרוטוקול (יציאה)

דפדפן אינטרנט של אנליסט

מתזמן אוטומטי

HTTPS (TCP/443)

דפדפן אינטרנט אנליסט

Azure AD

HTTPS (TCP/443)

מתזמן אוטומטי

אוטומציה של שרת מנוע

HTTPS (TCP/443)

מנוע אוטומטי

מתזמן אוטומטי

HTTPS (TCP/443)

מתזמן אוטומטי

Nuix UMS

HTTPS (TCP/443)

מתזמן אוטומטי

Azure AD

HTTPS (TCP/443)

מנוע Nuix

Nuix NMS

HTTPS (TCP/27443)

2. תנאים מוקדמים

לִרְאוֹת https://nuix.service-now.com/support?id=kb_סָעִיף_view&sys_kb_id=7ef9b32b47cc96102d9c89cbd36d4368[ https://nuix.service-now.com/support?id=kb_סָעִיף_view&sys_kb_id=7ef9b32b47cc96102d9c89cbd36d4368]

3. תצורה

3.1. הגדרות שירות

קבצי התצורה ממוקמים במיקומים הבאים:

  • אוטומציה של מתזמן C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • אוטומציה של שרת מנוע C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • אוטומציה של שרת OData C:\ProgramData\Nuix\Automate\ODataServer\config\config.yml

בנוסף, ניתן להגדיר אפשרויות תצורה מסוימות של שירות מתזמן באמצעות משתנים סביבתיים (ראה סעיף Scheduler Service Environmental Variables לפרטים נוספים.)

3.1.1. הגדרות שירות מתזמן

קבצים אלה עוקבים אחר תחביר YAML ומכילים את הפרמטרים הבאים:

  • role: SCHEDULER, המציין שהרכיב Automate Scheduler יפעל;

  • apiSecret: מפתח המשמש לאימות בין רכיבי אוטומציה. הגדר את אותו ערך אקראי בכל מופעי Automate Scheduler, Proxy ו- Server.

  • internalCredentials: מציין כי אישורים המוגדרים בקובץ התצורה ישמשו לאימות. התצורה ניתנת במפתחות המשנה הבאים:

    • displayName: (אופציונלי) השם שיוצג בדף הכניסה לשיטת אימות זו.

    • restrictToLocalhost: (אופציונלי) הגבל את הזמינות של האימות הפנימי לדפדפנים מ-localhost. אם מאפיין זה לא צוין, ברירת המחדל היא false.

    • usersEligibleLegalHoldAdministrator: (אופציונלי) הפוך משתמשים פנימיים לזכאים לניהול החזקה משפטית. אם מאפיין זה לא מצוין, ברירת המחדל שלו היא false.

    • usersEligibleLegalHoldCustodian: (אופציונלי) הפוך משתמשים פנימיים לזכאים ל-Leal Hold Custodians. אם מאפיין זה לא מצוין, ברירת המחדל שלו היא false.

    • credentials: רשימת האישורים.

ניתן לספק את האישורים בכל פורמט PBKDF2, באמצעות:

  • username

  • email

  • salt, מחרוזת מקודדת base64

  • iterations, מספר איטרציות ה-hash

  • hash, מחושב באמצעות אלגוריתם PBKDF2WithHmacSHA512 עם אורך מפתח של 512 ביטים.

או בטקסט ברור, באמצעות:

  • username

  • email

  • password

דוגמה לתצורת אימות פנימית עם שני משתמשים:

internalCredentials:
  displayName: UsernamePassword
  restrictToLocalhost: true
  credentials:
    - username: user1
      email: user1@example.com
      salt: NlbCqq8kL6sqdZQrjMmgSw==
      iterations: 1000000
      hash: ca4xiopDRshgyKvArOfKqBoDeVfbsOpayzVrh8n1WAWOhqvunITolqBBTiSAn1VxTBUz+15IfX4qxiTuHrthuA==

    - username: user2
      email: user2@example.com
      password: Password2@
שיטת האימות הפנימי דורשת אחסון שמות המשתמש והסיסמאות או ה-hash בקובץ התצורה. מומלץ להגביל שיטה זו ל-localhost.
הגדר את המאפיין restrictToLocalhost ל-true כדי לאפשר כניסה רק עם אישורים פנימיים בעת גישה לאוטומטי כמארח מקומי.

  • userSessionTimeout: משך השניות של חוסר פעילות שאחריו תפוג מושב משתמש.

  • nuixEnginePath: מיקום פריסת Nuix Engine. תיקיה זו צריכה להכיל תיקיות משנה bin, lib ו- directly ישירות.

  • log4jConfigurationFile: קובץ התצורה log4j.

  • enableCentralizedLogging: true או false המציין אם תכונת הרישום המרכזית מופעלת.

כברירת מחדל תכונה זו מופעלת, כדי להשבית תכונה זו הגדר את הערך ל- false

  • centralizedLoggingRetention: משך הימים שנשמר היומן.

  • centralizedLoggingMaxSize: גודל מסד הנתונים המרבי בבייטים לפני הפצה.

  • centralizedLoggingSizeCheckInterval: משך הזמן בשניות שאחריו מסד הנתונים מבצע בדיקת גודל.

  • enableRollingLoggingDatabases: כאשר מסד הנתונים של הרישום מוגדר עבור מסדי נתונים של SQLite יתגלגל, למשל כאשר מסדי הנתונים של הרישום יגיעו לגודל המקסימלי שהוגדר ב-centralizedLoggingMaxSize חלקי מספר מסדי הנתונים המתגלגלים שהוגדרו בהגדרה maxRollingLoggingDatabases. שם מסד הנתונים ישונה וייווצר מסד נתונים חדש. כברירת מחדל, תכונה זו מושבתת. לדוגמה, אם למשתמש היה גודל מקסימלי של 1GB ו-5 מסדי נתונים מתגלגלים, הגודל המרבי עבור כל מסדי הנתונים המתגלגל יהיה 200MB.

כאשר מסד הנתונים מגלגל יומנים, יומנים שהורדו יהיו גרסה מופשטת המכילה הכל מלבד היומנים האמיתיים ממסד הנתונים והרישום המרוכז יושבת באופן זמני. אם סיבוב מסד הנתונים מתרחש בזמן שהמשתמש מוריד יומנים, שרשור ההורדה ייצא וייתן למשתמש את היומנים שהוא הצליח לאסוף וליומן אזהרה כדי להודיע ​​למשתמש שההורדה יצאה עקב הסיבוב.

  • maxRollingLoggingDatabases: המספר המרבי של מסדי נתונים מתגלגלים. כאשר המספר המרבי של מסדי נתונים יגיע, מסד הנתונים עם היומנים הישנים ביותר יימחק.

  • enableCentralizedLoggingDownloadTimeout: true או false המציינים אם תכונת הזמן הקצוב להורדה של רישום רישום מרכזי מופעלת.

תכונה זו תסגור את הזרם להורדת יומנים לאחר מרווח מוגדר שהוגדר בהגדרת centralizedLoggingDownloadTimeout`. תכונה זו מומלצת רק למטרות פתרון בעיות והיא מושבתת כברירת מחדל.

  • centralizedLoggingDownloadTimeout: משך הזמן באלפיות שניות להורדת יומנים לפני היציאה, כברירת מחדל ערך זה מוגדר ל-180000 (3 דקות).

  • engineInitLogFolder: תיקיית היומן המשמשת במהלך אתחול המנוע, לפני ביצוע העבודה.

  • archiveJobsPastDuration: משך השניות שאחריו העבודות מסתיימות אוטומטית.

  • archiveJobsPastCount: המספר המרבי של עבודות שסיימו לאחר מכן העבירה אוטומטית של העבודה הישנה ביותר.

  • server: מציין את ה- IP / יציאות להאזנה ואת תעודת TLS לחיבורי HTTPS.

כברירת מחדל, השירות מאזין ב-HTTP ביציאה 80 ב-localhost, וב-HTTPS ביציאה 443 לכל כתובות ה-IP. כדי להגביל את השרת להאזין בכתובת IP ספציפית, שנה את 0.0.0.0 לכתובת ה-IP הנדרשת בקובץ config.yml.
אם משדרגים את מתזמן מגרסה לפני 6.0, השרת יקבל רק חיבורי HTTP/1.1 כברירת מחדל. כדי לאפשר חיבורי HTTP/2, שנה את type: https ל-type: h2 בקובץ config.yml.

  • webConfiguration: מציין אילו הגדרות אינטרנט להחיל על שרת האינטרנט המשמש עבור REST API, כולל הגנות HSTS, XSS, CORS ו-CSP.

  • cors: תצורת CORS.

ה-Automate REST API מיועד לגישה הן על ידי דף האינטרנט המאוחסן בשרת המתזמן, כמו גם משירותי צד שלישי ודפי אינטרנט. מסיבה זו, תצורת ברירת המחדל של CORS מאפשרת את כל המקורות. תצורה זו מאובטחת, מכיוון שכל בקשה ל- REST API צריכה להיות מאומתת באמצעות אסימון Bearer. אם יש צורך להגביל עוד יותר את המקורות המותרים ל-CORS, ניתן לקבוע מדיניות מחמירה יותר על ידי עריכת הגדרות ברירת המחדל של CORS בקובץ config.yml.

מדיניות CORS לדוגמה המגבילה את המקורות המותרים:

  cors:
    allowedOrigins: ["https://scheduler.example.com"]

  • logging: מציין את הפרמטרים של רישום הרישום שבוצע על ידי השירות. יומנים אלה יכילו גם את המידע שנרשם בדרך כלל על ידי Nuix Work Station. המיקום של יומני העובדים מוגדר בפרמטר nuixFlags.

  • applicationStore: מציין שמסד נתונים מותאם אישית משמש לאחסון מידע הביקורת.

    • driverClass: net.sourceforge.jtds.jdbc.Driver

    • user: שם המשתמש במסד הנתונים

    • password: סיסמת בסיס הנתונים

    • url: מחרוזת החיבור JDBC, למשל jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: מאפייני החיבור.

דוגמת תצורת SQL של Microsoft:

applicationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
אם לא מסופקים שם משתמש וסיסמה בתצורת Microsoft SQL Store, החיבור יתבצע באמצעות אימות משולב של Windows. בעת חיבור ל-Microsoft SQL בדרך זו, יש להגדיר את שירות Automate Scheduler כך שיפעל תחת חשבון שיש לו גישה למסד הנתונים של Microsoft SQL.

  • utilizationStore: מציין שמאגר נתונים מותאם אישית משמש לאחסון נתוני השימוש התפעולי.

  • loggingStore: מציין כי נעשה שימוש במסד נתונים מותאם אישית לאחסון יומני.

ה-loggingStore הוא מאגר מעגלי של כל יומני הפלטפורמה וצפוי לייצר תפוקת כתיבה. לא מומלץ להפנות את מאגר רישום זה למסד נתונים של SQL.

תצורה לדוגמה המחזירה את ה-loggingStore ל-D:\Logs\Automate:

loggingStore:
  driverClass: org.sqlite.JDBC
  url: jdbc:sqlite:D:/Logs/Automate/logging.db
  properties:
    charSet: UTF-8
ניתן להפנות את החנויות השונות המפורטות לעיל למסד נתונים SQL של מיקרוסופט יחיד, או להפרדת מסדי נתונים לפי הצורך.

  • defaultUserSettings: החלף את הגדרות המשתמש החלות כאשר לא הוגדרה תצורה ספציפית בפרופיל משתמש.

הגדרות לדוגמה להגדרת ערכי הפרמטר המותרים שאוכלסו כברירת מחדל בעת יצירת לקוח חדש או חומר חדש:

defaultUserSettings:
  newMatter:
    allowedParameterValues:
      - "{custodian}": ["John Smith","Annie Rosella"]
      - "{sample_parameter_1}": []
    synchronizeJobs: true
  newClient:
    allowedParameterValues:
      - "{doc_id_prefix}": ["DOC","DOC-","DOCID"]
      - "{sample_parameter_2}": []

  • sortAllowedParametersValues: true או false המציין אם יש למיין את ערכי הפרמטרים המותרים המוגדרים בממשק המשתמש או שהוחזרו על ידי סקריפטים וכי עליהם לשמור על הסדר המקורי.

  • jobMaximumExecutionParametersLength: מספר התווים שיכולים להיות לפרמטרים של ביצוע לפני שהערך נחתך. זה משפיע רק על הביצועים של הקצה הקדמי של מתזמן. כברירת מחדל, זה מוגדר לתווים 200.

  • archivedJobCleanupEnabled: true או false המציינים אם מנקה עבודות הארכיון צריך לפעול או לא, מה שמוחק את המשימה, יומני ביצוע המשימה וסטטיסטיקות של סוג mime של פעולות המשימה לאחר שמשימה מאוחסנת ישנה יותר ממספר ימים מוגדר. כברירת מחדל, הערך הוא false.

  • archivedJobCleanupInterval: מרווח הזמן בשעות עבור תדירות הפעלת משימת ניקוי המשימה. כברירת מחדל, מרווח זה מוגדר ל-24 שעות.

  • archivedJobRetentionDays: מספר הימים שיש לאחסן עבודה לפני שניתן יהיה למחוק אותה. כברירת מחדל, ערך זה מוגדר ל-584 ימים (שנה וחצי).

  • synchronizeJobsOnAllMatters: true או false המציין אם רק איוב אחד רשאי לרוץ על חומר בכל זמן נתון.

  • authTokenTtl: משך הזמן בשניות שאחריו פג תוקפו של אסימון אימות המשתמש. הדפדפן יגיש בקשה לרענן את אסימון האימות במחצית מתוחלת חיי האסימון. כברירת מחדל, זה מוגדר ל-600 שניות.

  • disableAuthTokenExpiration: true או false המציינים שקוד אימות המשתמש אינו פג. כברירת מחדל, זה מוגדר ל-false.

  • expiredAuthTokenTombstone: משך הזמן בשניות שבו יש לעקוב אחר אסימוני אימות שפג תוקפם. כאשר מנסים לגשת אל לְמַכֵּן עם אסימון אימות שפג תוקפו, מוחזרת הודעת שגיאה ידידותית, וההפעלה הנוכחית של המשתמש הנוכחית אינה חוקית. כברירת מחדל, זה מוגדר ל-900.

  • downgradeWebWorkerToken: true או false המציינים שהדפדפן צריך לשדרג לאחור את אסימון Web Worker כדי להפוך אותו לנגיש באמצעות סקריפטים בדפדפן. כברירת מחדל, זה מוגדר ל-false.

עם הגדרת ברירת המחדל של downgradeWebWorkerToken: false, בעת רענון חלון הדפדפן, המשתמש יתנתק. הגדרת אפשרות זו ל-true תשמור על הפעלת המשתמש כאשר חלון הדפדפן יתרענן, אך תהפוך את אסימון האימות לנגיש על ידי סקריפטים בדפדפן, וזה פחות מאובטח.

  • enforceSingleUserSession: true או false המציינים אם משתמש יכול לקיים יותר מפגישה אחת בו זמנית. אם אפשרות זו מוגדרת כ-true, רק פגישה אחת תותר.

אם משתמש כבר מחובר ותתחיל סשן אחר עבור אותו משתמש, הסשן הקודם ינותק.

  • libraryFileMaxSize: הגודל המרבי בבייטים של קבצים שניתן להעלות לספריית הקבצים, כברירת מחדל 10000000.

ספריית הקבצים נועדה לאחסן קובצי תצורה ופרופילים. מגבלה זו אינה חלה על קבצים שהועלו למאגרי נתונים.

  • expireIdleUploadAfter: משך הזמן באלפיות שניות שאחריו פג תוקף העלאות סרק למאגרי נתונים, כברירת מחדל 3600000 המקביל לשעה אחת.

  • uploadBufferMaxSize: גודל המאגר המקסימלי ב-KiB להקצאה במהלך העלאות למאגרי נתונים, כברירת מחדל 8192. ניתן להקצות את גודל המאגר עד 3 פעמים עבור כל העלאת קובץ, והוא משמש רק למשך העלאת הקובץ.

בעת כתיבת נתונים לשיתוף קבצים המחובר לרשת עם זמן אחזור גבוה, הגדלת גודל ה-uploadBufferMaxSize עשויה להגדיל את ביצועי ההעברה הכוללים במחיר של שימוש מוגבר בזיכרון.

  • uploadHashAlgorithms: האלגוריתם לשימוש עבור hashing בצד השרת בעת העלאת קבצים למאגרי נתונים, כברירת מחדל MD5. כדי לבטל hashing במהלך העלאה, השתמש בערך None.

גיבוב קבצים במהלך העלאה דורש משאבי CPU משמעותיים בשרת המתזמן. כדי להוריד את החישוב הזה לשרת אחר, השתמש בתפקיד פרוקסי של מתזמן.

  • enableUtilizationEndpoint: הפעל את שירות OData ב- Scheduler, כברירת מחדל true. כדי להשבית השתמש בערך false.

  • utilizationErrorsSoftFail: מסכת שגיאות כתיבה של מסד הנתונים של ניצול הנתונים לאפליקציה, כברירת מחדל false.

  • azureLocations: (אופציונלי) רשימת המיקומים שבהם יש להפעיל מכשירי VM. הגדרות לדוגמה של azureLocations:

azureLocations: westus,eastus

  • azureVmSizes: (אופציונלי) רשימת גדלי ה-VM. הגדרות 'azureVmSizes' לדוגמה:

azureVmSizes: Standard_M8ms,Standard_M16ms,Standard_M32ts

3.1.2. משתנים סביבתיים של שירות מתזמן

ניתן להגדיר את המשתנים הסביבתיים הבאים להגדיר או להחליף הגדרות שהוגדרו בקובץ התצורה של שירות המתזמן:

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

    • AUTOMATE_STORE_APPLICATION_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: כיתת הנהג, למשל org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: מחרוזת החיבור JDBC, למשל jdbc:postgresql://postgres.example.internal:5432/automateScheduler

    • AUTOMATE_STORE_APPLICATION_USERNAME: שם המשתמש במסד הנתונים

    • AUTOMATE_STORE_APPLICATION_PASSWORD: סיסמת בסיס הנתונים

    • AUTOMATE_STORE_APPLICATION_CHARSET: ערכת התווים של מסד הנתונים, למשל UTF-8

    • AUTOMATE_STORE_LOGGING_REDIRECT_TO_APPLICATION: הגדר ל-true כדי להפנות את הרישום המרוכז לאותו מיקום כמו חנות היישומים

    • AUTOMATE_CENTRALIZED_LOGGING_ENABLED: הגדר ל-false כדי לנטרל רישום מרכזי

    • AUTOMATE_STORE_UTILIZATION_REDIRECT_TO_APPLICATION: הגדר ל-true כדי להפנות את נתוני הניצול לאותו מיקום כמו חנות היישומים

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: המספר המינימלי של חיבורים שיש לשמור פתוחים

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: המספר המרבי של חיבורים שיש לשמור פתוחים

  • אימות. השתמש בהגדרות הבאות כדי להגדיר את אישורי הגישה כדי להיכנס ליישום עבור התצורה הראשונית:

    • אימות שם משתמש/סיסמה פנימי:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: הגדר ל-true כדי להפעיל

      • AUTOMATE_AUTH_INTERNAL_USERNAME: שם המשתמש להתחבר איתו

      • AUTOMATE_AUTH_INTERNAL_EMAIL: כתובת האימייל של המשתמש

      • AUTOMATE_AUTH_INTERNAL_PASSWORD: הסיסמה להתחבר איתה.

    • אימות PBKDF2 פנימי:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: הגדר ל-true כדי להפעיל

      • AUTOMATE_AUTH_INTERNAL_USERNAME: שם המשתמש להתחבר איתו

      • AUTOMATE_AUTH_INTERNAL_EMAIL: כתובת האימייל של המשתמש

      • AUTOMATE_AUTH_INTERNAL_SALT: מחרוזת מקודדת base64

      • AUTOMATE_AUTH_INTERNAL_ITERATIONS: מספר איטרציות ה-hash

      • AUTOMATE_AUTH_INTERNAL_HASH: הגיבוב של הסיסמה מחושב באמצעות אלגוריתם PBKDF2WithHmacSHA512 עם אורך מפתח של 512 ביטים.

    • אימות OIDC:

      • AUTOMATE_AUTH_OIDC_ENABLED: הגדר ל-true כדי להפעיל

      • AUTOMATE_AUTH_OIDC_NAME: שם מנגנון האימות

      • AUTOMATE_AUTH_OIDC_DESCRIPTION: תיאור מנגנון האימות

      • AUTOMATE_AUTH_OIDC_WELL_KNOWN_CONFIG_URI: URI התצורה הידועה, למשל http://keycloak:8080/realms/default/.well-known/openid-configuration

      • AUTOMATE_AUTH_OIDC_SCOPE: ההיקף, למשל openid email profile

      • AUTOMATE_AUTH_OIDC_USERNAME_CLAIM: תביעת שם המשתמש, למשל email

      • AUTOMATE_AUTH_OIDC_CLIENT_ID: מזהה הלקוח

      • AUTOMATE_AUTH_OIDC_CLIENT_SECRET: סוד הלקוח

    • שירות דרבי בקרת:

      • AUTOMATE_DERBY_CONTROL_SERVICE_ENABLED: הגדר ל-true כדי להפעיל

      • AUTOMATE_DERBY_CONTROL_SERVICE_NAME: שם שירות Derby Control

      • AUTOMATE_DERBY_CONTROL_SERVICE_DESCRIPTION: תיאור שירות דרבי בקרה

      • AUTOMATE_DERBY_CONTROL_SERVICE_URL: ה-URL הבסיסי של Derby Control, למשל http://127.0.0.1:8999/DERBY-CONTROL

  • סוד API מרובה שרתים. השתמש בהגדרות הבאות כדי להגדיר את סוד ה-API המשמש לניהול שרתי מנוע שונים:

    • AUTOMATE_API_SECRET: מפתח המשמש לאימות בין רכיבי אוטומציה. הגדר את אותו ערך אקראי בכל מופעי Automate Scheduler, Proxy ו- Server.

  • מדיניות אבטחה. השתמש בהגדרות הבאות כדי להגדיר מדיניות אבטחה:

    • AUTOMATE_SECURITY_POLICY_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_SECURITY_POLICY_NAME: שם הפוליסה

    • AUTOMATE_SECURITY_POLICY_DESCRIPTION: תיאור הפוליסה

    • AUTOMATE_SECURITY_POLICY_PRINCIPALS: רשימת המנהלים עליהם חלה הפוליסה. ההגדרה הבאה תתאים לכל משתמש מאומת: [{"identifierType":"BUILTIN","identifierName":"AUTHENTICATED_USER"}]

    • AUTOMATE_SECURITY_POLICY_PERMISSIONS: הרשאות המדיניות, למשל ["VIEW","VIEW_SENSITIVE","MODIFY","CREATE","SUBMIT_JOB","DOWNLOAD_LOGS"]

    • AUTOMATE_SECURITY_POLICY_SCOPE_BUILTIN: היקפים המובנים של הפוליסה, למשל ["ALL_CLIENT_POOLS","ALL_CLIENTS","ALL_LIBRARIES","API_KEYS","COLLECTIONS","LEGAL_HOLDS","SCRIPTS","SCHEDULES","SECURITY","RESOURCES"]

    • AUTOMATE_SECURITY_POLICY_SCOPE: באופן אופציונלי, הגדר את היקפי המדיניות המלאים, למשל [{"identifierType":"BUILTIN","identifierName":"RESOURCES"}]

  • מדיניות אבטחה. השתמש בהגדרות הבאות כדי להגדיר רישיון אוטומטי:

    • AUTOMATE_LICENSE_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_LICENSE_ID: מזהה הרישיון

    • AUTOMATE_LICENSE_KEY: מפתח הרישיון

    • AUTOMATE_LICENSE_DIAGNOSTIC_LEVEL: רמת האבחון, למשל ENHANCED

  • רישיון Nuix CLS. השתמש בהגדרות הבאות כדי להגדיר רישיון Nuix CLS:

    • AUTOMATE_NUIX_CLS_LICENSE_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_NUIX_CLS_LICENSE_NAME: שם הרישיון

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: תיאור הרישיון

    • AUTOMATE_NUIX_CLS_LICENSE_FILTER: מסנן עובד רישיון, למשל workstation

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: תיאור הרישיון

    • AUTOMATE_NUIX_CLS_LICENSE_USERNAME: שם המשתמש של CLS

    • AUTOMATE_NUIX_CLS_LICENSE_PASSWORD: סיסמת ה-CLS

  • מאגר משאבים. השתמש בהגדרות הבאות כדי להגדיר מאגר משאבים:

    • AUTOMATE_RESOURCE_POOL_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_RESOURCE_POOL_NAME: שם מאגר המשאבים

    • AUTOMATE_RESOURCE_POOL_DESCRIPTION: תיאור מאגר המשאבים

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ENABLED: הגדר ל-true כדי לאפשר רישום אוטומטי.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ACCESS_KEY: מפתח הגישה לרישום אוטומטי. שרתי המנוע צריכים להשתמש באותו מפתח.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_STRICT_IP: אופציונלי, הגדר ל-true כדי לאכוף רישום מאותה כתובת IP כמו שרת היעד, כברירת מחדל false.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_MIN_WORKERS: אופציונלי, הרישום האוטומטי מינימום עובדים, כברירת מחדל 1.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_TARGET_WORKERS: אופציונלי, הרישום האוטומטי מכוון לעובדים, כברירת מחדל 2.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_EXECUTION_MODE: אופציונלי, מצב ביצוע רישום אוטומטי, כברירת מחדל AUTOMATE_NUIX.

  • פרופיל ביצוע. השתמש בהגדרות הבאות כדי להגדיר פרופיל ביצוע:

    • AUTOMATE_EXECUTION_PROFILE_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_EXECUTION_PROFILE_NAME: שם פרופיל הביצוע

    • AUTOMATE_EXECUTION_PROFILE_DESCRIPTION: תיאור פרופיל הביצוע

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_COMMAND_LINE_PARAMS: אופציונלי, הפרמטרים של שורת הפקודה Engine, כברירת מחדל -Xmx16g -Dnuix.logdir=/var/log/nuix/automate -Duser.language=en -Duser.country=US.

    • AUTOMATE_EXECUTION_PROFILE_NUIX_ENGINE_FOLDER: אופציונלי, תיקיית המנוע הבינאריים של Nuix, כברירת מחדל /opt/nuix/engine.

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_LOG_FOLDER: אופציונלי, תיקיית היומן Engine, כברירת מחדל /var/log/nuix/automate.

    • AUTOMATE_EXECUTION_PROFILE_JAVA_FOLDER: אופציונלי, תיקיית Java binaries, כברירת מחדל ריקה.

    • AUTOMATE_EXECUTION_PROFILE_PARAMETERS: אופציונלי, מפה מסודרת של JSON<String,String> של פרמטר וערכים, כברירת מחדל ריקה.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_MIN_PERCENTAGE: אופציונלי, התקדמות העבודה המינימלית לפני הפסקת העבודה, כברירת מחדל 1.0.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_TIMEOUT_HOURS: אופציונלי, הזמן הקצוב שאחריו יש לבטל את העבודה אם התקדמות העבודה לא הושגה, כברירת מחדל 48.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_MIN_PERCENTAGE: אופציונלי, התקדמות הפעולה המינימלית לפני הפסקת העבודה, כברירת מחדל 1.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_TIMEOUT_HOURS: אופציונלי, הזמן הקצוב שאחריו יש לבטל את העבודה אם התקדמות הפעולה לא הושגה, כברירת מחדל 24.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_MIN_PERCENTAGE: אופציונלי, התקדמות הפעולה המינימלית לפני ניסיון לדלג על הפעולה, כברירת מחדל 1.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_TIMEOUT_HOURS: אופציונלי, פסק הזמן שאחריו לנסות לדלג על פעולת התקדמות הפעולה לא הושג, כברירת מחדל 12.0.

  • Dir. Data User השתמש בהגדרות הבאות כדי להגדיר את התנהגות User Data Dir:

    • AUTOMATE_USER_DATA_DIR_SCAN_INTERVAL: הגדר את משך המרווח בשניות שבו ה-User Data Dir ייסרק גם אם מערכת ההפעלה לא תזהה שינוי.

  • כדי להחליף הגדרה שרירותית, המר את שם ההגדרה לאותיות גדולות של נחש, לפניו Automate. לדוגמה, עבור הגדרת downgradeWebWorkerToken, השתמש במשתנה הסביבתי AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN.

3.1.3. הגדרות שירות proxy של מתזמן

קובץ זה עוקב אחר תחביר YAML ומכיל את הפרמטרים הבאים:

  • role: PROXY, המציין שהרכיב Automate Scheduler Proxy יפעל;

  • apiSecret: מפתח המשמש לאימות בין רכיבי אוטומציה. הגדר את אותו ערך אקראי בכל מופעי Automate Scheduler, Proxy ו- Server.

  • proxy: הפרטים של מופע מתזמן הראשי בו משתמש ה- proxy. התצורה ניתנת במפתחות המשנה הבאים:

    • baseUrl: כתובת ה- URL של מופע המתזמן.

    • whitelistedCertFingerprints: טביעות אצבע של אישור מתזמן המשמשות לאימות בעת פתיחת חיבור מאובטח.

  • allowedAuthenticationServices: רשימת שמות שירותי האימות שניתן להשתמש בהם דרך פרוקסי זה. אם הגדרה זו אינה מוגדרת, כל שירותי האימות יורשו דרך ה-Proxy.

תצורת שרת proxy לדוגמא:

proxy:
  baseUrl: https://scheduler.automate.local
  whitelistedCertFingerprints:
    - e62dd01ca608c10402d07714cfd626bfc6b1001e5a16ca039d1050a71f73ee24

allowedAuthenticationServices:
  - Internal
  - Lab Azure AD

  • log4jConfigurationFile: קובץ התצורה log4j.

  • server: מציין את הגדרות יומני הגישה לאינטרנט, את פרוטוקולי ה-HTTP להאזנה ואת אישור ה-IP, היציאה ו-TLS המתאימים עבור חיבורי HTTPS.

  • webConfiguration: מציין אילו הגדרות אינטרנט להחיל על שרת האינטרנט המשמש לממשק ה- REST.

3.1.4. הגדרות שירות שרת מנוע

קובץ זה עוקב אחר תחביר YAML ומכיל את הפרמטרים הבאים:

  • role: ENGINE_SERVER, המציין שרכיב Automate Engine Server יפעל;

  • apiSecret: מפתח המשמש לאימות בין רכיבי אוטומציה. הגדר את אותו ערך אקראי בכל מופעי Automate Scheduler, Proxy ו- Server.

  • nuixEnginePath: מיקום פריסת Nuix Engine. תיקיה זו צריכה להכיל תיקיות משנה bin, lib ו- directly ישירות.

  • log4jConfigurationFile: קובץ התצורה log4j.

  • engineInitLogFolder: המיקום הזמני המשמש את מנועי לאחסון קבצי תצורה ויומני שלב בשלב האתחול. בעת הפעלת משרות, המנוע יאחסן את יומני הרישום וקבצי התצורה במיקום שצוין בפרופיל הביצוע.

  • engineInitTimeout: הזמן הקצוב לשניות שהמנוע רשאי לאתחל, כברירת מחדל 120.

  • engineAbortTimeout: הזמן הקצוב באלפיות שניות שהמנוע ימתין לביטול עבודה, הוא ברירת המחדל 5000 (5 שניות)

  • server: מציין את הגדרות יומני הגישה לאינטרנט, את פרוטוקולי ה-HTTP להאזנה ואת אישור ה-IP, היציאה ו-TLS המתאימים עבור חיבורי HTTPS.

  • webConfiguration: מציין אילו הגדרות אינטרנט להחיל על שרת האינטרנט המשמש לממשק ה- REST.

  • jobRunningLogMaxSize: מציין את המספר המרבי של יומנים שעבודת הריצה מאחסנת, כברירת מחדל 20.

  • logging: מציין את הפרמטרים של רישום הרישום שבוצע על ידי השירות. יומנים אלה יכילו גם את המידע שנרשם בדרך כלל על ידי Nuix Work Station. המיקום של יומני העובדים מוגדר בפרמטר nuixFlags.

  • workerBrokerIP: כתובת ה- IP המשמשת לאירוח מתווכים עובדים בעת הפעלת עובדים מרוחקים.

  • workerBrokerStartPort: תחילת היציאה מתחילה עבור מתווכים עובדים.

  • workerBrokerEndPort: סוף טווח הנמל עבור מתווכים עובדים.

הגדרות לדוגמא להגדרת תצורה של עובד ברוקר ב- IP 10.0.0.1:

workerBrokerIP: 10.0.0.1
workerBrokerStartPort: 50000
workerBrokerEndPort: 50100
אם ההגדרה workerBrokerIP לא מסופקת, השרת יפעיל מתווך במתאם רשת ברירת מחדל. בסביבה בה יש לשרתים מספר מתאמי רשת, הגדר את ה - workerBrokerIP בכל שרת עם כתובת ה- IP שאמורה לשמש שרתים אחרים המצטרפים לעבודות מרוחקות כדי ליצור קשר עם שרת זה.

3.1.5. שרת מנוע משתנים סביבתיים

ניתן להגדיר את המשתנים הסביבתיים הבאים להגדיר או להחליף הגדרות שהוגדרו בקובץ התצורה של Engine Server Service:

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

    • AUTOMATE_STORE_APPLICATION_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: כיתת הנהג, למשל org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: מחרוזת החיבור JDBC, למשל jdbc:postgresql://postgres.example.internal:5432/automateEngineServer

    • AUTOMATE_STORE_APPLICATION_USERNAME: שם המשתמש במסד הנתונים

    • AUTOMATE_STORE_APPLICATION_PASSWORD: סיסמת בסיס הנתונים

    • AUTOMATE_STORE_APPLICATION_CHARSET: ערכת התווים של מסד הנתונים, למשל UTF-8

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: המספר המינימלי של חיבורים שיש לשמור פתוחים

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: המספר המרבי של חיבורים שיש לשמור פתוחים

  • רישום אוטומטי. השתמש בהגדרות הבאות כדי לרשום אוטומטית את שרת המנוע למאגר משאבים של מתזמן. יש להגדיר את מאגר המשאבים כאשר תכונת הרישום האוטומטי מופעלת:

    • AUTOMATE_REGISTRATION_ENABLED: הגדר ל-true כדי להפעיל

    • AUTOMATE_REGISTRATION_SERVER_NAME: השם של שרת המנוע, למשל Server1

    • AUTOMATE_REGISTRATION_SERVER_URL: כתובת האתר שהמתזמן יכול לגשת לשרת המנוע בתור, למשל http://Server1.internal.local

    • AUTOMATE_REGISTRATION_SCHEDULER_URL: כתובת האתר של המתזמן, למשל http://Scheduler.internal.local

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ID: אופציונלי, מזהה מאגר המשאבים שאפשר להירשם איתו. כברירת מחדל, המזהה של מאגר המשאבים שהוגדר ב- Scheduler עם משתני ENV. יש לספק הגדרה זו רק כדי להירשם למאגר משאבים אחר.

    • AUTOMATE_REGISTRATION_ROLE_MAIN: אופציונלי, הגדר ל-true לאפשר למנוע לפעול כמנוע ראשי במאגר המשאבים.

    • AUTOMATE_REGISTRATION_ROLE_REMOTE: אופציונלי, הגדר ל-true לאפשר למנוע לפעול כמנוע מרוחק במאגר המשאבים.

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ACCESS_KEY: מפתח הגישה למאגר המשאבים. ראה את אותו ערך שהוגדר במאגר המשאבים עם המשתנה ENV.

  • פריסה מרובת שרתים. השתמש בהגדרות הבאות עבור תרחישי פריסה מרובי שרתים:

    • לְמַכֵּן_API_SECRET: מפתח המשמש לאימות בין רכיבי אוטומציה. הגדר את אותו ערך אקראי בכל מופעי Automate Scheduler, Proxy ו- Server.

    • לְמַכֵּן_SERVER_ID: הגדר מזהה אקראי ייחודי עבור כל שרת מנוע.

  • פריסת רישום מנוע

    • AUTOMATE_ENGINE_LOG_LAYOUT_JSON: Set to true כדי להגדיר את יומני המנוע להיות בפורמט JSON. שים לב, זה לא חל על פורמטים של יומן מתזמן או Engine Server, המוגדרים ישירות ב-config.yml שלהם.

3.1.6. הגדרות שירות שרת OData

קובץ זה עוקב אחר תחביר YAML ומכיל את הפרמטרים הבאים:

  • role: ODATA_SERVER, המציין שהרכיב Automate OData Server יפעל;

  • internalCredentials: מציין כי אישורים המוגדרים בקובץ התצורה ישמשו לאימות. התצורה ניתנת במפתחות המשנה הבאים:

    • displayName: (אופציונלי) השם שיוצג בדף הכניסה לשיטת אימות זו.

    • restrictToLocalhost: (אופציונלי) הגבל את הזמינות של האימות הפנימי לדפדפנים מ-localhost. אם מאפיין זה לא צוין, ברירת המחדל היא false.

    • credentials: רשימת האישורים.

ניתן לספק את האישורים בכל פורמט PBKDF2, באמצעות:

  • username

  • email

  • salt, מחרוזת מקודדת base64

  • iterations, מספר איטרציות ה-hash

  • hash, מחושב באמצעות אלגוריתם PBKDF2WithHmacSHA512 עם אורך מפתח של 512 ביטים.

או בטקסט ברור, באמצעות:

  • username

  • email

  • password

דוגמה לתצורת אימות פנימית עם שני משתמשים:

internalCredentials:
  displayName: UsernamePassword
  restrictToLocalhost: true
  credentials:
    - username: user1
      email: user1@example.com
      salt: NlbCqq8kL6sqdZQrjMmgSw==
      iterations: 1000000
      hash: ca4xiopDRshgyKvArOfKqBoDeVfbsOpayzVrh8n1WAWOhqvunITolqBBTiSAn1VxTBUz+15IfX4qxiTuHrthuA==

    - username: user2
      email: user2@example.com
      password: Password2@
שיטת האימות הפנימי דורשת אחסון שמות המשתמש והסיסמאות או ה-hash בקובץ התצורה. מומלץ להגביל שיטה זו ל-localhost.
הגדר את המאפיין restrictToLocalhost ל-true כדי לאפשר כניסה רק עם אישורים פנימיים בעת גישה לאוטומטי כמארח מקומי.

  • server: מציין את הגדרות יומני הגישה לאינטרנט, את פרוטוקולי ה-HTTP להאזנה ואת אישור ה-IP, היציאה ו-TLS המתאימים עבור חיבורי HTTPS.

כברירת מחדל, השירות מאזין ב-HTTP ביציאה 8081 ב-localhost, וב-HTTPS ביציאה 8443 לכל כתובות ה-IP. כדי להגביל את השרת להאזין בכתובת IP ספציפית, שנה את 0.0.0.0 לכתובת ה-IP הנדרשת בקובץ config.yml.

  • webConfiguration: מציין אילו הגדרות אינטרנט להחיל על שרת האינטרנט המשמש לממשק ה- REST.

  • utilizationStore: מציין שמסד נתונים מותאם אישית משמש לאחסון מידע הביקורת.

    • driverClass: net.sourceforge.jtds.jdbc.Driver

    • user: שם המשתמש במסד הנתונים

    • password: סיסמת בסיס הנתונים

    • url: מחרוזת החיבור JDBC, למשל jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: מאפייני החיבור.

דוגמת תצורת SQL של Microsoft:

utilizationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
אם לא מסופקים שם משתמש וסיסמה בתצורת Microsoft SQL Store, החיבור יתבצע באמצעות אימות משולב של Windows. בעת חיבור ל-Microsoft SQL בדרך זו, יש להגדיר את שירות Automate Scheduler כך שיפעל תחת חשבון שיש לו גישה למסד הנתונים של Microsoft SQL.

3.2. אימות

3.2.1. Nuix UMS

אם אתה משתמש בשיטת האימות של Nuix UMS, הגדר את שירות אימות UMS בדף האינטרנט אוטומציה, בכרטיסייה הגדרות, תחת שירותי אימות. כל המשתמשים המוגדרים ב- Nuix UMS יוכלו להיכנס לאוטומציה. רמת הגישה של כל משתמש נקבעת על פי מדיניות האבטחה המוגדרת בדף האינטרנט אוטומציה, בכרטיסייה הגדרות.

3.2.2. LDAP

אם אתה משתמש בשיטת אימות LDAP, הגדר את שירות אימות LDAP בדף האינטרנט אוטומציה, בכרטיסייה הגדרות, תחת שירותי אימות. כל המשתמשים המוגדרים ב- LDAP המסופק domainDN יוכלו להיכנס לאוטומציה. רמת הגישה של כל משתמש נקבעת על פי מדיניות האבטחה המוגדרת בדף האינטרנט אוטומציה, בכרטיסייה הגדרות.

3.2.3. פנימי

אם אתה משתמש בשיטת האימות הפנימי, הגדר את תצורת internalCredentials בקובץ YAML כפי שמצוין בService Settings.

3.3. גישה למדיניות אבטחה

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

3.4. זיכרון

3.4.1. עובדי Nuix

ניתן לציין את הזיכרון של עובדי Nuix בפעולה fl, או במפורש כפרמטר של שורת פקודה בפרופילי הביצוע, למשל:

-Dnuix.worker.jvm.arguments=&quot;-Xmx8g&quot;

3.4.2. מנוע Nuix

הזיכרון של מנוע ה- Nuix, שווה ערך לזיכרון של תחנת העבודה של Nuix כפרמטר של שורת פקודה בפרופילי הביצוע, למשל:

-Xmx2g
כל מנוע Nuix יפעל תחת JVM נפרד ולא ישתף זיכרון עם מנועי Nuix האחרים או שירותי Automate.

3.5. מקורות נתונים משותפים

זרימות עבודה אוטומטיות מבוצעות בשרתים המריצים את רכיב Automate Engine Server. כדי להבטיח שזרימות עבודה יכולות לגשת למקרים ולנתוני מקור ממיקום משותף, ספק נתיב UNC או נתיב אות כונן ממופה אשר נגיש מכל השרתים המריצים את רכיב Automate Engine Server.

כברירת מחדל, שירות Automate Engine Server פועל תחת חשבון המערכת המקומית, ומפעיל את המנועים תחת אותו חשבון משתמש.

ניתן לציין חשבון משתמש אחר בפרופילי ביצוע, לפי הצורך.

4. פתרון תקלות

4.1. דפדף לאוטומציה של מתזמן

כברירת מחדל, Automate Scheduler מאזין ב-127.0.0.1 ביציאה 80 וכל כתובות ה-IP ביציאה 443. כדי לגשת להתקנת ברירת המחדל, דפדף לכתובת: http://localhost

4.2. שירות אוטומטי לא מתחיל

אוטומציה של מתזמן ושרת מנוע פועלים כשירותי Windows. אם השירותים הופעלו, בדוק את קובצי היומן ב-C:\Temp\Log\automate-scheduler.log ו-C:\Temp\Log\automate-engine-server.log.

4.3. שגיאת התחברות

אם השגיאה שגיאה בתקשורת עם שרת האימות מוצגת בעת ניסיון להיכנס, בדוק את היומנים כדי לקבוע את הבעיה בה נתקל Automate בעת תקשורת עם שרת האימות.

4.4. הוספת Automate Engine Server זורקת שגיאת javax.net.ssl.SSLHandshakeException

ודא שסביבת Java Runtime מהגרסה העדכנית ביותר של Nuix Workstation הפרוסה על כל שרת Automate Scheduler סומך על אישור ה-TLS של Automate Engine Server. ראה סעיף Managing Certificates לפרטים נוספים.

5. ניהול תעודות

ראה https://nuix.service-now.com/support?id=kb_סָעִיף_view&sys_kb_id=fcd9bfe747cc96102d9c89cbd36d438f.

6. ניצול ודיווח

נתוני השימוש והדיווח מסופקים כעדכון OData V4, אם תכונה זו מופעלת ברישיון האוטומטי.

עדכון ה- OData תומך רק בשאילתת המטא נתונים ובאחזור כל הנתונים מהתצוגות. מסנני OData אינם נתמכים.

ניתן לגשת לעדכון ה- OData בנקודת הקצה הבאה באמצעות אימות בסיסי או Microsoft OAuth:

  • /api/v2/reporting/odata

7. תיעוד REST API

ניתן לגשת אל Automate Scheduler ישירות עבור דפדפן, או באמצעות REST API. התיעוד של ה-API מסופק בפורמט OpenAPI v3, תחת /openapi.

לדוגמה, כדי לגשת לתיעוד ה-API בהתקנה רגילה של Automate Scheduler, דפדף אל http://localhost/openapi

8. רישום רישום מרכזי

רישום רישום מרכזי מאחד את כל יומני היומנים מתזמן המתזמן, שרת המנוע, מנוע והעובדים לתוך מסד הנתונים של רישום המנוהל על ידי מתזמן.

רישום ריכוז מופעל כברירת מחדל, כלומר קובץ היומן וגם יומן מסד הנתונים יהיו קיימים. כדי להשבית רישום ריכוזי, הגדר את מקש enableCentralizedLogging ל- false בקובץ התצורה as כפי שצוין בקובץ Service Settings.

אם רישום רישום מרכזי אינו זמין, יומני העבודות להורדה ותכונות יומני המערכת להורדה יושבתו.

רישום ריכוזי ימחק באופן אוטומטי יומנים ישנים יותר מתקופת השמירה. תקופת השמירה המוגדרת כברירת מחדל היא 30 ימים. כדי לשנות את תקופת השמירה, ערוך את מקש centralizedLoggingRetention בקובץ YAML.

כאשר גודל יומני מסד הנתונים חורג מגודל מסד הנתונים המרבי, יומנים ישנים יותר יימחקו. כברירת מחדל, גודל מסד הנתונים המרבי הוא 1000000000 בתים (1 GB). כדי לשנות את ברירת המחדל של גודל מסד הנתונים המרבי ערוך את מקש centralizedLoggingMaxSize בקובץ YAML.

גודל מסד הנתונים של רישום הרישום בפועל עשוי לחרוג מהגודל המרבי שצוין, עקב תקורה של מסד נתונים ועיכובים במחיקת שורות יומן ישנות.

9. מלאי Filepaths

9.1. ברירת מחדל של נתוני קבצים

9.1.1. מתזמן

  • C:\Program Files\Nuix\Automate: תיקיית התקנה

  • %programdata%\Nuix\Automate\Scheduler\config: תיקיית תצורה

  • %programdata%\Nuix\Automate\Scheduler\stores: התמדה וארכיב של פרטי תפקידים, ניצול, ביקורת, דיווח וניצול

  • C:\Temp\logs\automate-scheduler.log: יומן יישומים

  • C:\Temp\logs\automate-scheduler.%d.log.zip: קובצי יומן אפליקציות קודמים

  • C:\Temp\logs\automate-scheduler-access.log: יומן גישה לאינטרנט

  • C:\Temp\logs\automate-scheduler-access.%d.log.zip: קבצי יומן ראשי קודמים

  • C:\Temp\logs\Automate Scheduler.wrapper.log: יומני עטיפת שירות

  • C:\Temp\logs\Automate Scheduler.err.log: יומן שגיאות סטנדרטי של שירות

  • C:\Temp\logs\Automate Scheduler.out.log: יומן פלט סטנדרטי של שירות

9.1.2. שרת מנוע

  • C:\Program Files\Nuix\Automate: תיקיית התקנה

  • %programdata%\Nuix\Automate\EngineServer\config: תיקיית תצורה

  • C:\Temp\logs\automate-engine-server.log: יומן יישומים

  • C:\Temp\logs\automate-engine-server.%d.log.zip: קובצי יומן אפליקציות קודמים

  • C:\Temp\logs\automate-engine-server-access.log: יומן גישה לאינטרנט

  • C:\Temp\logs\automate-engine-server-access.%d.log.zip: קבצי יומן ראשי קודמים

  • C:\Temp\logs\Automate Engine Server.wrapper.log: יומני עטיפת שירות

  • C:\Temp\logs\Automate Engine Server.err.log: יומן שגיאות סטנדרטי של שירות

  • C:\Temp\logs\Automate Engine Server.out.log: יומן פלט סטנדרטי של שירות

9.1.3. מנוע

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.log: יומן init

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.yml: תצורת Init

  • C:\Temp\logs\automate-engine.aaaaaaaa-service.exe: עטיפת שירות

  • C:\Temp\logs\automate-engine.aaaaaaaa-service.xml: תצורת שירות

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.log: יומן משרות

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.yml: תצורת עבודה

9.2. שינוי מיקומי יומן

ניתן לשנות את נתוני הקבצים המוגדרים כברירת מחדל מהמיקומים הבאים:

  • יומן ראשי של מתזמן: עדכן את החלק logging מ- C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • יומנים הקשורים לשירות מתזמן: עדכן את התגים <workingdirectory> ו- <logpath> מ- C:\Program Files\Nuix\Automate\Scheduler\Automate Scheduler.xml

  • יומן הראשי של שרת המנוע: עדכן את החלק logging מ- C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • יומנים הקשורים לשירות מנוע: עדכן את התגים <workingdirectory> ו- <logpath> מ- C:\Program Files\Nuix\Automate\EngineServer\Automate Engine Server.xml

  • יומן התחלת מנוע, קביעת תצורה ויומני שירות: עדכן את החלק engineInitLogFolder מ- C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • יומן משרות ותצורה: עדכן את השדה Log Folder והגדר את הפרמטר של שורת הפקודה -Dnuix.logdir=c:\Temp\Logs בפרופיל הביצוע