מצוקה

פלטפורמת הליבה
duress_acknowledge_incidentמצוקה

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

תמיד אשרו קודם. קראו בלי confirm כדי לקבל את האירוע, ספרו למשתמש על מה הוא מאשר קבלה, וקראו שוב עם confirm: true רק לאחר שהוא מסכים.

בתוך workflow, או מתוך Agent, הפעולה עובדת רק כשתוכנית התגובה של המתקן מאפשרת ל-workflows לאשר קבלה, לסגור ולהפעיל אזעקות. כדי לסגור אירוע, השתמשו ב-duress_resolve_incident.

פרמטרים

שםסוגתיאור
incidentId*stringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
notestringהערה אופציונלית, לדוגמה "בדרך לקבלה"
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_buttons_readמצוקהDuress Configurationניהול מכשירים

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

סוללה: low הוא 30% או פחות (להחליף בקרוב), critical הוא 20% או פחות (להחליף עכשיו). battery ו-lastSeenAt עם ערך null פירושם שאף מסך עדיין לא שמע את הלחצן. הזמנים בתבנית ISO.

פעולות:

  • status: סטטוס הלחצנים. כל לחצן עם אזור, חדר, סוללה, מתי מסך שמע אותו לאחרונה ומתי נבדק לאחרונה. "האם לחצני המצוקה עובדים?", "לאילו לחצנים צריך סוללות חדשות?"
  • list: פרופילי הלחצנים. הפרופיל המלא של כל לחצן: מה ש-duress_buttons_write update משנה, וגם אות, המסכים ששמעו אותו ביממה האחרונה, תקינות הפיקוח ובדיקת הגדרה ממתינה.
  • link_options: אפשרויות קישור. המצלמות, הדלתות, המסכים ואזורי הגישה של המתקן שאפשר לקשר אליהם לחצן (מזהים עבור duress_buttons_write update).
  • receivers: מקלטי הלחצנים. מסכי התצוגה במתקן ששומעים לחצנים ומעבירים לחיצות, והאם כל אחד מהם מקוון. ready הוא false כשאין דבר שיכול לשמוע לחצן.
  • setup_test: בדיקת הגדרה. בדיקת ההגדרה של לחצן שנוסף לאחרונה: waiting (הלחיצה הראשונה שלו היא בדיקה בלבד), received, expired, ended או none, והאם מסך שמע אותו מאז שנוסף. דורשת deviceSerialNumber.

פרמטרים

שםסוגתיאור
action*"status" | "list" | "link_options" | "receivers" | "setup_test"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (status, list)
cursorstringnextCursor מהעמוד הקודם (status, list)
deviceSerialNumberstringהמספר הסידורי של הלחצן, מ-duress_buttons_read status או list (setup_test)
duress_buttons_writeDuress Configurationמצוקהניהול מכשירים

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

שדות שהושמטו מ-update שומרים על הערכים שלהם; null מנקה אותם. קראו את הפרופיל הנוכחי עם duress_buttons_read list.

פעולות:

  • update: עדכון לחצן. שומרת את הפרופיל של הלחצן במתקן שבו הוא רשום (דורשת Duress Configuration שם). zone הוא 001 עד 999 וייחודי במתקן. alertsMutedUntil (ISO, עד 30 ימים קדימה) משתיק את התראות הסוללה והניתוק שלו. דורשת deviceSerialNumber.
  • locate: השמעת צפצוף מלחצן. גורמת ללחצן לצפצף ולהבהב למשך 30 שניות כדי שהצוות ימצא אותו, לדוגמה לחצן שממשיך לדווח על סוללה חלשה. מסך שנמצא לידו שולח את הפקודה, ולכן הלחצן חייב להיות בטווח של מסך. לא כשיש לו אזעקה פתוחה. דורשת deviceSerialNumber.
  • go_live: העברת לחצן חדש לפעולה חיה. מסיימת מיד את בדיקת ההגדרה של לחצן שנוסף לאחרונה, כך שהלחיצה הבאה שלו תהיה אזעקה אמיתית. בדקו קודם עם duress_buttons_read setup_test. דורשת ניהול מכשירים או Duress Configuration במתקן. דורשת deviceSerialNumber. מבקשת אישור.
  • remove: הסרת לחצן. מבטלת את הצימוד של הלחצן למתקן ומוחקת את הפרופיל שלו, מה שמפנה את האזור שלו. לא כשיש לו אזעקה פתוחה. דורשת ניהול מכשירים במתקן. דורשת deviceSerialNumber. מבקשת אישור.
  • add: הוספת לחצן. רושמת לחצן מצוקה חדש במתקן לפי המספר הסידורי המודפס עליו. כברירת מחדל, הלחיצה הראשונה שלו ב-30 הדקות הבאות היא בדיקה בלבד (setupTest). המתקן צריך מסך שבו Duress alarm monitoring מופעל או IoT Gateway. דורשת ניהול מכשירים במתקן. דורשת deviceSerialNumber. מבקשת אישור.

פרמטרים

שםסוגתיאור
action*"update" | "locate" | "go_live" | "remove" | "add"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
deviceSerialNumberstringהמספר הסידורי של הלחצן, מ-duress_buttons_read status או list
labelstringnullאיך הצוות קורא ללחצן, לדוגמה "דלפק קבלה" (update)
roomstringnullהחדר שבו הוא נמצא (update, add)
zonestringnullאזור במוקד הניטור, 001 עד 999 (update)
placement"fixed" | "carried" | "null"fixed (מותקן קבוע) או carried (תליון נישא) (update)
notesstringnullהערות לצוות (update)
cameraIdsarraynullמצלמות שמקושרות ללחצן (מזהים מ-duress_buttons_read link_options); null או [] מנקים אותן (update)
doorIdsarraynullדלתות שמקושרות ללחצן (מזהים מ-duress_buttons_read link_options); null או [] מנקים אותן (update)
screenIdsarraynullמסכים שמקושרים ללחצן (מזהים מ-duress_buttons_read link_options); null או [] מנקים אותם (update)
accessZoneIdstringnullאזור הגישה שבו נמצא הלחצן (update)
alertsMutedUntilstringnullתאריך ושעה בתבנית ISO שעד אליהם יושתקו התראות המכשיר שלו; null מבטל את ההשתקה (update)
muteReasonstringnullלמה ההתראות שלו מושתקות (update)
setupTestbooleanברירת מחדל true: הלחיצה הראשונה היא בדיקה בלבד (add)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_end_testמצוקה

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

פרמטרים

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

קורא אירועי אזעקת מצוקה (איש צוות לחץ על לחצן מצוקה, או ש-workflow הפעיל אזעקה): רשימות, ציר הזמן והמסירות של אירוע אחד, דוח תחקיר, וצילומי הטלוויזיה במעגל סגור סביב אזעקה.

סטטוסים: open (אף אחד עדיין לא אישר קבלה), acknowledged (מישהו מגיב), resolved (נסגר, עם סיווג: genuine, false_alarm, test או unknown). active פירושו open או acknowledged. אירועי בדיקה (isTest) נוצרים מבדיקות לחצנים; testType 'unplanned' הוא אזעקה שהופעלה כאמיתית ושמגיב סגר כבדיקה.

סטטוס מסירה: sent, acknowledged (המקבל אישר), failed (ראו error), shadow (הרצת ניסיון, דבר לא נשלח). מסירות למוקד הניטור מסוכמות גם תחת monitoringCentre. התוצאות מציינות שמות של אנשים אבל לעולם לא כוללות מספרי טלפון או כתובות דוא"ל. הזמנים בתבנית ISO.

פעולות:

  • list: הצגת אירועים. החדשים ביותר ראשונים. scope: facility (ברירת מחדל; המתקן שצוין או המחובר) או organisation (כל מתקן בארגון שאתם יכולים לראות; ברירת המחדל היא הארגון של המתקן).
  • get: קבלת אירוע. הסטטוס, הלחצנים שנלחצו, ציר הזמן (לחיצות, הסלמות, אישורי קבלה, הערות) וכל ניסיון מסירה של התראה או למוקד הניטור עם התוצאה שלו. דורשת incidentId.
  • report: דוח אירוע. לתחקיר: האירוע, השניות עד אישור הקבלה ועד הסגירה, השלבים שהושגו, כל רשומה בציר הזמן, מה נשלח בכל ערוץ ומה נכשל, והאם הצילומים נשמרו. שלבו עם duress_incidents_write add_note כדי לצרף את התחקיר לאירוע. דורשת incidentId.
  • footage_previews: צילומי האזעקה. כל מצלמה בצילומי האזעקה: הסטטוס שלה, מספר הפריימים והקליפים, קליפים שהועלו, והפריים הקרוב ביותר ללחיצה (posterSeconds). עם cameraId, רק המצלמה הזו וגם שניות ה-Unix של כל פריים (frameSeconds). דורשת טלוויזיה במעגל סגור במתקן. דורשת incidentId.
  • footage_frame: פריים מצילומי האזעקה. פריים timelapse אחד מצילומי האזעקה, שמוחזר כתמונה: עותק שמור לאחר שהצילומים נשמרו, אחרת הפריים החי בתוך חלון האזעקה. seconds הוא ערך posterSeconds או frameSeconds מ-footage_previews. דורשת incidentId, cameraId, seconds.

פרמטרים

שםסוגתיאור
action*"list" | "get" | "report" | "footage_previews" | "footage_frame"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
scope"facility" | "organisation"ברירת מחדל facility (list)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים. (list)
organisationIdstringעבור scope organisation. ברירת המחדל היא הארגון של המתקן. (list)
status"active" | "open" | "acknowledged" | "resolved"active הוא open או acknowledged (list)
fromstringתאריך ושעה בתבנית ISO: אירועים שנפתחו במועד הזה או אחריו (list)
tostringתאריך ושעה בתבנית ISO: אירועים שנפתחו במועד הזה או לפניו (list)
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (list)
cursorstringnextCursor מהעמוד הקודם (list)
incidentIdstringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress. (get, report, footage_previews, footage_frame)
cameraIdstringמצלמה בצילומי האזעקה, מ-footage_previews (footage_previews, footage_frame)
secondsintegerstringזמן הפריים כשניות Unix בנות 10 ספרות (footage_frame)
duress_incidents_writeמצוקהDuress Configuration

משנה אירוע מצוקה בלי לגעת באזעקה עצמה: נותן לו שם, מוסיף הערות צוות, ושומר או משחרר את צילומי הטלוויזיה במעגל סגור סביבו. איש אינו מקבל התראה. כדי לאשר קבלה, לסגור או לעדכן את המגיבים, השתמשו ב-duress_acknowledge_incident, duress_resolve_incident או duress_post_update.

פעולות:

  • rename: מתן שם לאירוע. נותנת שם לאירוע כדי שיהיה קל למצוא אותו בהמשך, לדוגמה "מבקר תוקפני בדלפק הקדמי". שם ריק או null מסיר אותו. השמות מוצגים במסוף Duress ובדוחות. דורשת incidentId.
  • add_note: הוספת הערה. מוסיפה הערה לציר הזמן של האירוע, לדוגמה מה המשתמש מצא או מי הגיע. בכל סטטוס; רק הצוות רואה הערות והן אינן משנות את האירוע. כתבו אותה במילים של המשתמש ואשרו איתו את הניסוח קודם. דורשת incidentId, note.
  • keep_footage: שמירת צילומי האזעקה. שומרת את צילומי הטלוויזיה במעגל סגור סביב אזעקה אמיתית שנסגרה, כדי שלא יימחקו יחד עם ההקלטות הרגילות, לפי הדקות והמצלמות שבתוכנית התגובה. מתבצעת כמה דקות לאחר מכן, אחרי ההעלאה. לא לבדיקות, לאזעקות פתוחות או לצילומים שכבר נשמרו או שוחררו. דורשת incidentId.
  • release_footage: שחרור צילומים שמורים. מוותרת על הצילומים שנשמרו עבור אזעקה: הקליפים חוזרים למדיניות השמירה הרגילה והפריימים השמורים נמחקים, כך שלא ניתן יהיה לצפות בהם עוד אחרי שתוקף ההקלטות הרגילות יפוג. דורשת Duress Configuration במתקן. דורשת incidentId. מבקשת אישור.

פרמטרים

שםסוגתיאור
action*"rename" | "add_note" | "keep_footage" | "release_footage"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
incidentIdstringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
namestringnullהשם; ערך ריק או null מסיר אותו (rename)
notestringההערה (add_note)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_lift_lockdownמצוקה

מסיר את הנעילה הכללית של אזעקת מצוקה: הדלתות שננעלו מכניסות שוב אנשים. עובד בלי קשר לסטטוס האזעקה.

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

פרמטרים

שםסוגתיאור
incidentId*stringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_post_updateמצוקה

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

אשרו קודם. קראו בלי confirm כדי לבדוק את האירוע, הראו למשתמש את הניסוח המדויק, וקראו שוב עם confirm: true לאחר שהוא מסכים. למשהו שרק הצוות צריך לראות, השתמשו במקום זאת ב-duress_incidents_write add_note.

פרמטרים

שםסוגתיאור
incidentId*stringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
text*stringהעדכון, מילה במילה
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_raise_alarmמצוקה

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

  • reason: מה קרה, לדוגמה "דלת נפרצה ביציאה האחורית" (עד 200 תווים).
  • deviceSerialNumber: אופציונלי. לחצן שהמיקום שלו ישמש; רק אז גם מוקד הניטור מקבל הודעה, עם האזור של הלחצן הזה.

רק כשלב ב-workflow, במתקנים שתוכנית התגובה שלהם מאפשרת ל-workflows לאשר קבלה, לסגור ולהפעיל אזעקות. כל עוד האזעקה של ה-workflow הזה פתוחה, הוא לא יפעיל אזעקה נוספת; במקום זאת הוא מחזיר את האזעקה הקיימת.

פרמטרים

שםסוגתיאור
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
reason*stringמה קרה
deviceSerialNumberstringלחצן במתקן (אופציונלי)
duress_reports_readמצוקהDuress Configuration

דיווח תאימות של Duress עבור מתקן, מותג או ארגון: זמני תגובה (P50/P95), אירועים לפי סיווג ושיעור אזעקות השווא, כיסוי בדיקות ומתקנים שהבדיקה שלהם באיחור, זמינות לחצנים, הצלחת מסירה למוקד הניטור, וייצוא של כל אירוע בנפרד. וגם ההתראות שלא נמסרו מהאזעקה האחרונה במתקן אחד.

הימים לפי השעון המקומי של המתקן; תקופות של יותר מ-400 ימים מקוצרות (range.capped). אירועים אמיתיים ואירועי בדיקה נספרים בנפרד. משכי הזמן במילישניות (p50Ms, p95Ms). דוחות מותג מכסים רק את המתקנים שאתם יכולים לגשת אליהם, אלא אם יש לכם גישה ברמת הארגון כולו (scope.restrictedToAccessibleFacilities).

פעולות:

  • overview: סקירת דוח Duress. סיכומים, מגמה חודשית ומדדים לפי ארגון, לפי מותג ולפי מתקן (incidents, testCoverage, deviceUptime, deliveries). המתקנים מוצגים בעמודים.
  • compliance_summary: סיכום תאימות של Duress. מה שדוח ה-PDF של התאימות מציג: כיסוי בדיקות עם מתקנים שהבדיקה שלהם באיחור, זמינות לחצנים, הצלחת מסירה, בדיקות אחרונות (testHistory), ולכל מתקן הבדיקה, התרגיל והאזעקה האמיתית האחרונים שלו עם הזמינות של כל לחצן. המתקנים מוצגים בעמודים.
  • incident_export: ייצוא אירועי Duress. שורה אחת לכל אירוע, הישן ביותר ראשון, עם העמודות של ייצוא ה-CSV: מתקן, בדיקה או אמיתי, סטטוס, סיווג, זמנים מקומיים, שניות עד אישור הקבלה ועד הסגירה, מי אישר קבלה ומי סגר, לחצנים ומספרי מסירות.
  • delivery_problems: התראות אזעקה שלא נמסרו. האזעקה או הבדיקה האחרונה של המתקן (עם כל חלון הבדיקה שלה) וההתראות שלא הגיעו, לפי ערוץ. problems הוא null כשהכול הגיע. דורשת Duress או Duress Configuration שם.

פרמטרים

שםסוגתיאור
action*"overview" | "compliance_summary" | "incident_export" | "delivery_problems"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
scope"facility" | "brand" | "organisation"ברירת מחדל: המזהה הספציפי ביותר שניתן, אחרת המתקן המחובר. (overview, compliance_summary, incident_export)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
brandIdstringמזהה המותג, עבור התבנית של המותג במקום מתקן (overview, compliance_summary, incident_export)
organisationIdstringדורש גישה ל-Duress ברמת הארגון כולו (overview, compliance_summary, incident_export)
fromstringהיום הראשון, YYYY-MM-DD לפי השעון המקומי של המתקן (ברירת מחדל 30 ימים לפני to) (overview, compliance_summary, incident_export)
tostringהיום האחרון, YYYY-MM-DD לפי השעון המקומי של המתקן, כולל (ברירת מחדל היום) (overview, compliance_summary, incident_export)
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (overview, compliance_summary, incident_export)
cursorstringnextCursor מהעמוד הקודם (overview, compliance_summary, incident_export)
duress_resolve_incidentמצוקה

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

  • disposition: genuine (מקרה חירום אמיתי), false_alarm, test או unknown.
  • note: מה קרה. חובה עבור אזעקה אמיתית.

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

בתוך workflow, או מתוך Agent, הפעולה עובדת רק כשתוכנית התגובה של המתקן מאפשרת ל-workflows לאשר קבלה, לסגור ולהפעיל אזעקות.

פרמטרים

שםסוגתיאור
incidentId*stringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
disposition*"genuine" | "false_alarm" | "test" | "unknown"התוצאה
notestringמה קרה. חובה כשהסיווג הוא genuine.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_settings_readמצוקהDuress Configuration

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

מתקן פועל לפי התבנית של המותג שלו (אחרת של הארגון שלו), מרחיב אותה עם אנשי קשר נוספים (mode extend), או מחליף אותה בתוכנית משלו (mode replace). שנו הגדרות עם duress_settings_write. הזמנים בתבנית ISO.

פעולות:

  • response_plan: תוכנית תגובה. התוכנית שבתוקף במתקן (effective) ומה כל רמה מכילה (sources: facility, brand, organisation), או עם brandId בלבד, התבנית של המותג. אנשי הקשר מוצגים כפי שנשמרו, מוכנים לעריכה ולשמירה חוזרת.
  • resolved_plan: תוכנית מחושבת. מי מנוע האזעקות יוצר איתו קשר במתקן, שכבה אחר שכבה: תפקידים שמפורטים לאנשים, הערוצים שבהם אפשר להשיג כל אחד, השהיות, ואזהרות שיש לתקן לפני אזעקה. שמות בלבד, ללא מספרי טלפון או כתובות דוא"ל.
  • contact_options: אפשרויות אנשי קשר. אנשים ותפקידים שאפשר להוסיף לתוכנית של המתקן (דורשת Duress Configuration שם), או עם brandId בלבד לתבנית של המותג, בכפוף לכללי אנשי הקשר של המותג.
  • device_alerts: התראות מכשיר. מי מקבל הודעה על סוללות חלשות, לחצנים מנותקים, אובדן כיסוי ומסירות שנכשלו: הכללים בכל רמה והנמענים המחושבים של המתקן, או עם brandId בלבד, הכללים של המותג.
  • contact_rules: כללי אנשי הקשר של המותג. אילו תפקידים מתקנים במותג רשאים להוסיף לתוכניות: allowAllExcept מסתיר את התפקידים שפורטו, manual מציע רק אותם. דורשת את מה שעריכת תוכנית המותג דורשת. דורשת brandId.
  • plan_status: סטטוס התוכניות של המותג. כל מתקן במותג: האם הוא פועל לפי התבנית, מרחיב אותה או שיש לו תוכנית משלו, כמה אנשי קשר הוא הוסיף, והאזהרות של התוכנית שלו. דורשת brandId.
  • buttons_summary: סקירת לחצנים. כל מתקן במותג או בארגון: לחצנים, ספירות של סוללות וניתוקים, הבדיקה הבאה והאחרונה. הנתונים של הסקירות ב-Brands & Customisation ושל הארגון.
  • monitoring: ניתוב למוקד הניטור. איך אזעקות יוצאות מהמתקן: eaAlarmType none, cid (קריאה למוקד ניטור דרך eaAlarmProvider) או relay (לוח קווי דרך eaRelayModel), והספקים שהמתקן יכול להשתמש בהם.

פרמטרים

שםסוגתיאור
action*"response_plan" | "resolved_plan" | "contact_options" | "device_alerts" | "contact_rules" | "plan_status" | "buttons_summary" | "monitoring"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים. (response_plan, resolved_plan, contact_options, device_alerts, monitoring)
brandIdstringמזהה המותג, עבור התבנית של המותג במקום מתקן (response_plan, contact_options, device_alerts, contact_rules, plan_status, buttons_summary)
organisationIdstringמזהה הארגון (buttons_summary)
duress_settings_writeDuress Configuration

משנה את הגדרות Duress: תוכניות תגובה (במתקן, או בתבנית של מותג או ארגון), התראות מכשיר, כללי אנשי הקשר של המותג, ולאן אזעקות נשלחות למוקד הניטור. כל שינוי מבקש אישור כי הוא משנה את מי שמקבל התראה.

העבירו אחד מ-facilityId (ברירת מחדל: המתקן המחובר), brandId או organisationId. תוכניות של מתקן דורשות Duress Configuration שם; תבניות דורשות מנהל ארגון עם Duress Configuration, או עבור מותג, Duress Configuration בכל מתקן בו. קראו קודם עם duress_settings_read.

פעולות:

  • save_response_plan: שמירת תוכנית תגובה. שכבות של אנשי קשר שמקבלים התראה afterSeconds אחרי הלחיצה (בסדר עולה, הראשונה בדרך כלל 0), ackRequired, תזכורות ו-responseActions. מתקן יכול במקום זאת להרחיב את התבנית שלו (mode extend) עם תוספות. שדות שהושמטו שומרים על הערכים השמורים שלהם; responseActions ממוזגות לפי פעולה. מבקשת אישור.
  • remove_response_plan: הסרת תוכנית תגובה. מוחקת את התוכנית ששמורה ברמה הזו, כך שמתקן חוזר לפעול לפי התבנית שלו ומותג חוזר לתבנית של הארגון. מבקשת אישור.
  • save_device_alerts: שמירת התראות מכשיר. מחליפה את כללי התראות המכשיר ברמה הזו: עד 10 כללים, כל אחד קבוצה של אירועים ואנשי קשר (push, sms או email). שמרו את מזהי הכללים שנקראו מ-duress_settings_read device_alerts. דורשת rules. מבקשת אישור.
  • remove_device_alerts: הסרת התראות מכשיר. מוחקת את כללי התראות המכשיר ברמה הזו, כך שהיא חוזרת לפעול לפי הרמה שמעליה. מבקשת אישור.
  • save_contact_rules: שמירת כללי אנשי הקשר של המותג. אילו תפקידים המתקנים של המותג יכולים להוסיף לתוכניות: allowAllExcept מסתיר את roleIds, manual מציע רק את roleIds. אנשי קשר שכבר נשמרו נשארים; התוכניות המחושבות מתרעננות. דורשת brandId, mode, roleIds. מבקשת אישור.
  • save_monitoring: שמירת הניתוב למוקד הניטור. לאן אזעקות נשלחות: eaAlarmType none, cid (דורש eaAlarmProvider, אחד מהספקים ש-duress_settings_read monitoring מפרט) או relay (eaRelayModel). דורשת Duress Configuration במתקן. דורשת eaAlarmType. מבקשת אישור.

פרמטרים

שםסוגתיאור
action*"save_response_plan" | "remove_response_plan" | "save_device_alerts" | "remove_device_alerts" | "save_contact_rules" | "save_monitoring"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים. (save_response_plan, remove_response_plan, save_device_alerts, remove_device_alerts, save_monitoring)
brandIdstringמזהה המותג, עבור התבנית של המותג במקום מתקן (save_response_plan, remove_response_plan, save_device_alerts, remove_device_alerts, save_contact_rules)
organisationIdstringמזהה הארגון, עבור התבנית של הארגון (save_response_plan, remove_response_plan, save_device_alerts, remove_device_alerts)
mode"replace" | "extend"לתוכניות של מתקן בלבד: replace (שכבות משלו) או extend (תוספות לתבנית) (save_response_plan, save_contact_rules)
tiersarrayהשכבות של התוכנית (mode replace ותבניות) (save_response_plan)
additionsarraymode extend: אנשי קשר נוספים לכל שכבה בתבנית (tierId ו-afterSeconds ממנה) (save_response_plan)
ackRequiredbooleanהאם ההסלמה נמשכת עד שמישהו מאשר קבלה (save_response_plan)
remindersobjectnullחזרה על ההתראות כל everySeconds (0 מכבה אותן) עד stopAfterSeconds (save_response_plan)
responseActionsobjectפעולות לפי שם, כל אחת { enabled, ... }: unlockOnAcknowledge (doorIds), lockdown, staffScreenAlerts, buttonAcknowledge, dashboardCctv, dashboardDoorControls, dashboardResolve, updateTexts, aiSummary, workflowControl, retainFootage (minutesBefore, minutesAfter, cameras) (save_response_plan)
rulesarrayהכללים; רשימה ריקה לא שומרת אף כלל (אף אחד כאן לא מקבל התראה) (save_device_alerts)
roleIdsarrayמזהי התפקידים שהמצב חל עליהם (save_contact_rules)
eaAlarmType"none" | "cid" | "relay"none, cid או relay (save_monitoring)
eaAlarmProviderstringnullעבור cid: קוד הספק (save_monitoring)
eaRelayModel"none" | "numato-rl80001"עבור relay: לוח הממסרים (save_monitoring)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_start_lockdownמצוקה

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

לעולם לא לאזעקות בדיקה או לאזעקות שנסגרו. דורש Door/Gate Access במתקן.

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

פרמטרים

שםסוגתיאור
incidentId*stringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_start_testמצוקה

מתחיל מיד בדיקת מצוקה במתקן. עד שהיא מסתיימת, כל לחיצה היא בדיקה ולא אזעקה אמיתית:

  • walk: הצוות לוחץ על כל לחצן; רק השלב הראשון של תוכנית התגובה מקבל התראה, עם התווית TEST.
  • drill: כל תוכנית התגובה פועלת, עם התווית TEST.

אנשי הקשר לבדיקות של המתקן מקבלים הודעה שהבדיקה התחילה, ותוצאות כ-10 דקות אחרי שהיא מסתיימת. בדיקה אחת בכל פעם לכל מתקן. סיימו אותה מוקדם עם duress_end_test; קבעו בדיקות מראש עם duress_tests_write.

אשרו קודם. קראו בלי confirm, ספרו למשתמש שלחיצות לא יפעילו אזעקות אמיתיות במשך durationMinutes, וקראו שוב עם confirm: true לאחר שהוא מסכים. בתוך workflow, או מתוך Agent, הפעולה עובדת רק כשתוכנית התגובה של המתקן מאפשרת ל-workflows לאשר קבלה, לסגור ולהפעיל אזעקות.

פרמטרים

שםסוגתיאור
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
type"walk" | "drill"walk (ברירת מחדל) או drill
durationMinutesintegerכמה זמן לחיצות נחשבות לבדיקות (ברירת מחדל 60)
monitoringCentreMode"test-codes" | "none"`test-codes` שולח למוקד הניטור אותות בדיקה; `none` לא שולח לו דבר
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_tests_readמצוקהDuress Configuration

קורא בדיקות של לחצני מצוקה: לוחות הזמנים שקובעים אותן (walk, comms או drill, חד-פעמיות או חוזרות, עבור ארגון, מותגים או מתקנים), חלונות הבדיקה שהם יוצרים בכל מתקן (scheduled, active, completed, cancelled, וגם בדיקות אד-הוק), והתוצאות של חלון (אילו לחצנים נלחצו או הוחמצו, מי קיבל הודעה, אותות למוקד הניטור, זמני אישור קבלה).

מי קבע, שינה או ביטל בדיקה לא מוצג; מקבלי המסירות מושחרים. הזמנים בתבנית ISO; localDate ו-localStartTime באזור הזמן של המתקן. קבעו או שנו בדיקות עם duress_tests_write; התחילו בדיקה עכשיו עם duress_start_test.

פעולות:

  • schedules: לוחות זמנים של בדיקות. scope facility (ברירת מחדל; כל לוח זמנים שמכסה אותו, כולל משותפים שהוא מדלג עליהם או מחליף), brand (brandId) או organisation (ברירת מחדל: הארגון של המתקן). השינוי החדש ביותר ראשון.
  • windows: חלונות בדיקה. חלונות הבדיקה של מתקן מ-from עד to (ברירת מחדל: בערך שבוע אחורה עד חודש קדימה), או עם organisationId בלבד, החלונות הקרובים של הארגון בכל המתקנים שלו.
  • results: תוצאות בדיקה. חלון והתוצאות שלו: נשמרות לאחר שנשלחו, מחושבות בזמן אמת בזמן שבדיקה פועלת (רשימת התיוג של בדיקת walk), null לחלונות מתוזמנים או מבוטלים. דורשת Duress במתקן. דורשת startsAtKey.

פרמטרים

שםסוגתיאור
action*"schedules" | "windows" | "results"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
scope"facility" | "brand" | "organisation"ברירת מחדל facility (schedules)
facilityIdstringמזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
brandIdstringמזהה המותג, עבור התבנית של המותג במקום מתקן (schedules)
organisationIdstringעבור scope organisation (schedules, windows)
includeCancelledbooleanכולל בדיקות שבוטלו (schedules, windows)
limitintegerפריטים לעמוד (ברירת מחדל 25, לכל היותר 100) (schedules, windows)
cursorstringnextCursor מהעמוד הקודם (schedules, windows)
fromstringתאריך ושעה בתבנית ISO (windows)
tostringתאריך ושעה בתבנית ISO (windows)
startsAtKeystringחלון הבדיקה (startsAtKey), מ-duress_tests_read windows (results)
duress_tests_writeDuress Configurationמצוקה

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

לוחות זמנים דורשים Duress Configuration על כל היעד שלהם (מנהל ארגון עבור לוחות זמנים ברמת הארגון). השעות הן לפי אזור הזמן של כל מתקן. קראו תחילה את לוחות הזמנים והחלונות באמצעות duress_tests_read; כדי להתחיל בדיקה עכשיו השתמשו ב-duress_start_test.

פעולות:

  • create_schedule: קביעת לוח זמנים לבדיקות. קובע חלונות עד כשנה מראש בכל מתקן ב-target ושולח בדוא"ל אישור הזמנה. דורש name, type, target, startDate, localStartTime ו-recurrence. דורש name, type, target, startDate, localStartTime, recurrence. מבקש אישור.
  • update_schedule: שינוי לוח זמנים לבדיקות. שדות שלא נשלחו שומרים על ערכיהם. חלונות עתידיים נכתבים מחדש (חלונות שכבר התחילו נשארים) ובעלי העניין מקבלים הודעה על השינוי. לאחר מכן השתמשו ב-ownerScope שבתוצאה. דורש ownerScope, scheduleId. מבקש אישור.
  • cancel_schedule: ביטול לוח זמנים לבדיקות. מבטל את לוח הזמנים ואת החלונות העתידיים שלו ושולח בדוא"ל הודעת ביטול. מתקנים שיש להם עותק משלהם שומרים עליו. דורש ownerScope, scheduleId. מבקש אישור.
  • set_facility_override: שינוי לוח זמנים משותף עבור מתקן אחד. mode follow (הפעלה מחדש של לוח הזמנים המשותף כאן), skip (עצירתו כאן) או own (החלפתו כאן בעותק שנבנה מ-schedule). דורש Duress Configuration במתקן זה בלבד. דורש ownerScope, scheduleId, mode. מבקש אישור.
  • cancel_window: ביטול חלון בדיקה אחד. מבטל בדיקה מתוזמנת אחת במתקן (לוח הזמנים ממשיך) ושולח דוא"ל לבעלי העניין שלה. דורש Duress במתקן; בדיקה פעילה מסתיימת במקום זאת באמצעות duress_end_test. דורש startsAtKey. מבקש אישור.

פרמטרים

שםסוגתיאור
action*"create_schedule" | "update_schedule" | "cancel_schedule" | "set_facility_override" | "cancel_window"מה לעשות; כל פעולה מתוארת בתיאור הכלי.
namestringמוצג בהודעות הדוא"ל וביומן (create_schedule, update_schedule)
type"walk" | "comms" | "drill"walk (לחיצה על כל לחצן), comms (לחיצה אחת לכל נתיב ניטור) או drill (תגובה מתורגלת) (create_schedule, update_schedule)
targetobjectאילו מתקנים: הארגון כולו, brandIds או facilityIds (create_schedule, update_schedule)
startDatestringהמופע הראשון, YYYY-MM-DD לפי אזור הזמן של כל מתקן (create_schedule, update_schedule)
localStartTimestringHH:mm לפי אזור הזמן של כל מתקן (create_schedule, update_schedule)
durationMinutesintegerברירת מחדל 60 (create_schedule, update_schedule)
recurrence"once" | "monthly" | "quarterly" | "twice-yearly" | "yearly"once, monthly, quarterly, twice-yearly או yearly (create_schedule, update_schedule)
repeatOnobjectnullחזרה ביום ה-n בשבוע בחודש במקום באותו תאריך; null מנקה את ההגדרה (create_schedule, update_schedule)
monitoringCentreMode"test-codes" | "none"test-codes שולח את האותות כבדיקות; none משאיר את מוקד הניטור מחוץ לבדיקה (create_schedule, update_schedule)
extraEmailsarrayמקבלים גם הם בדוא"ל את ההזמנה, התזכורות והתוצאות (create_schedule, update_schedule)
organisationIdstringברירת מחדל: הארגון של המתקן המחובר (create_schedule, update_schedule, cancel_schedule, set_facility_override)
ownerScopestringמתוך duress_tests_read schedules, לדוגמה brand#b-123; הערך עשוי להשתנות כשהיעד משתנה (update_schedule, cancel_schedule, set_facility_override)
scheduleIdstringמתוך duress_tests_read schedules (update_schedule, cancel_schedule, set_facility_override)
facilityIdstringמזהה מתקן. אופציונלי כשהמתקן המחובר הוא המתקן הרצוי. (set_facility_override, cancel_window)
mode"follow" | "skip" | "own"follow, skip או own (set_facility_override)
scheduleobjectmode own: השדות של העותק (היעד הוא תמיד מתקן זה); שדות שלא נשלחו נלקחים מלוח הזמנים המשותף (set_facility_override)
startsAtKeystringחלון הבדיקה (startsAtKey), מתוך duress_tests_read windows (cancel_window)
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה
duress_unlock_doorsמצוקה

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

לעולם לא עבור אזעקות בדיקה או אזעקות שטופלו. דורש Door/Gate Access במתקן.

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

פרמטרים

שםסוגתיאור
incidentId*stringמזהה האירוע (inc_...), מ-duress_incidents_read list או מהטריגר של workflow של Duress.
doorIdsarrayחלק מהדלתות שהוצגו בקריאה בלי confirm. השמיטו כדי לכלול את כולן.
confirmbooleanהגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה