™ WeR@Home Manager User Guide ESUGSL002 Version 2.2 April 2017 Table of Contents Table of Contents 1. 2. 3. 4. 5. 2 Introduction .......................................................................................................................................... 4 1.1. WeR@Home™ Manager Implementation ................................................................................... 4 1.2. Admin User .................................................................................................................................5 1.3. Login ...........................................................................................................................................5 Main Page ............................................................................................................................................... 7 2.1. System Status ..............................................................................................................................7 2.2. Firmware Update........................................................................................................................ 9 2.2.1 Recent Updates ............................................................................................................ 9 2.2.2 Version Management .................................................................................................. 10 2.2.3 RSU in Progress ............................................................................................................ 11 2.3. Hub Management ..................................................................................................................... 12 2.3.1 Filters........................................................................................................................... 14 2.4. Reports...................................................................................................................................... 16 2.5. User Admin ............................................................................................................................... 17 2.6. Panels Registration .................................................................................................................... 18 2.7. System Parameters.................................................................................................................... 18 2.8. View Package Offerings ............................................................................................................ 19 Version Management ...........................................................................................................................20 3.1. Add Version Release ................................................................................................................ 20 3.2. Edit Version Release .................................................................................................................. 23 3.3. Delete Version Release ............................................................................................................ 24 RSU In Progress ..................................................................................................................................... 25 4.1. Selected Batch Panels Status ..................................................................................................... 25 4.2. Devices In Upgrade ...................................................................................................................26 Hub Management ................................................................................................................................. 28 5.1. Hub Details ...............................................................................................................................29 5.1.1 Hub Version ............................................................................................................... 30 5.1.2 Set Configuration ........................................................................................................ 31 5.1.2.1 Assigning a Service Level Package ........................................................... 31 5.1.2.2 Assigning an HD Camera Service Level.................................................... 32 5.1.2.3 Enabling Monitoring Status ..................................................................... 32 5.1.3 Hub Management Commands .................................................................................... 33 5.1.4 Change Server Process ................................................................................................36 5.1.4.1 Prerequisites ............................................................................................36 5.1.4.2 Change Server Procedure........................................................................ 37 5.2. Registered Users ....................................................................................................................... 38 WeR@Home™ Manager User Guide Table of Contents 5.3. Installed Devices .......................................................................................................................39 5.3.1 Using CM Support Mode ............................................................................................. 41 5.4. Event History ............................................................................................................................43 5.4.1 History Details ............................................................................................................ 44 5.4.2 Retrieve History Details .............................................................................................. 45 6. Reports Management ........................................................................................................................... 47 6.1. Report: All WeR@Home Registered Panels .............................................................................. 48 6.2. Report: Panel and Devices Status ............................................................................................. 49 6.3. Report: Users ........................................................................................................................... 50 6.4. Report: Recent Events............................................................................................................... 51 6.5. Report: Recent Commands ....................................................................................................... 52 6.6. Report: User Registration.......................................................................................................... 53 6.7. Report: Suspended Accounts.................................................................................................... 53 6.8. Report: Account Detailed Activity ........................................................................................... 54 6.9. Report: Account Activity Summary ........................................................................................... 55 6.10. Report: Service Level History to Days .......................................................................................56 6.11. Report: Service Level History to Dates ...................................................................................... 57 6.12. Report: HD Camera Service Level History .................................................................................58 7. User Administration .............................................................................................................................. 59 7.1. Accessible Modules...................................................................................................................59 7.2. Add User ................................................................................................................................... 61 7.3. Edit User....................................................................................................................................62 7.4. Delete User ...............................................................................................................................63 8. Panels Registration .............................................................................................................................. 64 9. System Parameters ...............................................................................................................................66 10. View Package Offerings ........................................................................................................................ 67 Appendix A RSU Status Logging .............................................................................................................71 WeR@Home™ Manager User Guide 3 Introduction 1. Introduction WeR@Home™ Manager is a web-based application, designed to support you or the service provider system administrator. WeR@Home™ Manager provides you with the tools to manage and maintain WeR@Home™ systems belonging to your customer base. WeR@Home™ Manager enables maintenance, control, and remote software update, transparent to the WeR@Home™ users. Your system administrators can use the WeR@Home™ Manager to get a detailed picture of the users’ WeR@Home™ systems, to provide better maintenance and operation support. WeR@Home™ Manager enables you to manage your customers’ WeR@Home™ service levels including the service level for HD camera usage and video storage. The WeR@Home™ Manager includes capabilities such as: Updating hub firmware and software Viewing hub statistics such as status and version Viewing hub event history Providing command control of all hubs Managing user profiles Searching for information using an advanced search engine Generating customized HTML reports Allowing for mass registration of multiple hubs in the WeR@Home™ Manager application Viewing service package offerings including HD camera service packages NOTE: The terms “hub” and “panel” are interchangeable. 1.1. WeR@Home™ Manager Implementation The WeR@Home™ Manager application is an integrative part of the WeR@Home™ server installation. The data about the hubs in your customer base is available to your system administrators, which includes the following information: 4 Event history User profiles Device configuration WeR@Home™ Manager User Guide Introduction Device firmware statistics Registration date Last connect time The customer group with which the hub is associated System arming status GSM reception level Service level packages by user type Authorization rules for service level packages HD camera service level Third-party event monitoring capability 1.2. Admin User The Admin user is defined during the WeR@Home™ server installation and is granted total access to the system. The Admin user manages the WeR@Home™ Manager application, including defining other users in the system with full or limited access. User access is defined by granting access to the various modules in the application. For example, a user with access to the User Admin module is granted privileges to manage users and user profiles. Refer to 7 User Administration on page 59. 1.3. Login Ensure you have the following to use WeR@Home™ Manager: A personal computer (PC) with Windows 7 or later, with internet access and one of the following browsers: Microsoft™ Internet Explorer® 8 or later Firefox® 4 or later Google Chrome™, any version The URL for the WeR@Home™ Manager application User credentials provided by the system administrator. WeR@Home™ Manager User Guide 5 Introduction NOTE: Contact Essence Professional Support for the URL to access the WeR@Home™ Manager application. To login to the WeR@Home™ Manager application: 1. In your web browser, enter the URL to the WeR@Home™ Manager application. The WeR@Home™ Manager Login page appears. Figure 1 – Login Page 2. Enter the user credentials, provided by your system administrator. NOTE: If you forget your password, contact your WeR@Home™ Manager system administrator to reset your password. The System Status page of the WeR@Home™ Manager application appears displaying operational statistics. Refer to 2.1 System Status on page 7. 6 WeR@Home™ Manager User Guide Main Page 2. Main Page The main page of the WeR@Home™ Manager application provides access to the application modules. The username of the user who is logged-on appears above the quick access bar, next to the Log Out switch, as shown in Figure 2. Figure 2 – Quick Access Bar The application modules are: System Status: refer to 2.1 System Status on page 7. Firmware Update: refer to 2.2 Firmware Update on page 9. Hub Management: refer to 2.3 Hub Management on page 12. Reports: see section 2.4 Reports on page 16. User Admin: refer to 2.5 User Admin on page 17. Panels Registration: refer to 2.6 Panels Registration on page 18. System Parameters: refer to 2.7 System Parameters on page 18. View Package Offerings: refer to 2.8 View Package Offerings on page 19. 2.1. System Status The System Status module provides you with a dashboard-style representation of the information about each group of hubs. Figure 3 – System Status Pie Charts WeR@Home™ Manager User Guide 7 Main Page The System Status displays three pie charts, shown in Figure 3, representing WeR@Home™ statistics in the Statistics tables, shown in Figure 4. Figure 4 – System Status Statistics Table All categories in the System Status Statistics page are hyperlinks to the Hub Management module. Table 1 describes the information in the System Status Statistics tables. Table 1: System Status Statistics Statistics Group WeR@Home Statistics Remote SW Update (RSU) Statistics Category Description Total Panels The total number of activated hubs in the customer base, regardless of status Registered Panels All the registered hubs that have completed first-time registration: Each of these hubs has an owner with contact information. Online Registered Panels All the registered hubs that are currently connected to the Server Offline Registered Panels All the registered hubs that are not currently connected to the Server Armed Panels All the registered hubs whose status is “Armed” Panels in current batch All the hubs that are included in the currently batch for software module upgrade Pending Panels All the hubs awaiting software module upgrades In Process Panels All the hubs currently undergoing software module upgrades Completed Panels All the hubs that have completed their software module upgrades Failed Panels All the hubs whose software module upgrade did not complete successfully Click on a category to drill-down to the Hub Management module and display the hubs included in the category. Refer to 2.3 Hub Management on page 12. 8 WeR@Home™ Manager User Guide Main Page 2.2. Firmware Update The Firmware Update module includes the following processes: Recent Updates Version Management RSU In Progress 2.2.1 Recent Updates Click Recent Updates on the Firmware Update dropdown menu to display the Recent Updates table. The hub software update information listed in the Recent Updates table is retrieved according to the table filter period. The filter retrieves and displays the hubs updated within the filter period. The filter period is required. The default filter period is from the beginning of the current month to the current day. To the right of each filter date field is . You can only enter the dates for the filter period using . Once the Calendar is open, as shown in Figure 5 below, you can either enter the dates manually or select them from the dropdown calendar. The dates are in mm/dd/yy format. Figure 5 – Filter Calendar Mechanism Table 2 describes the information in the Recent Updates table. Table 2: Recent Updates Information Field Name Description Customer The group to which the owner belongs Serial The hub serial number WeR@Home™ Manager User Guide 9 Main Page Field Name Description Name The name of the hub owner Mobile The cellular phone number of the owner Status Time The last time a status notification was sent concerning the update of the software of the hub and its peripherals, within the filter period. Enter Date and Time in the following formats respectively: MM/DD/YYYY HH:MI AM/PM Note: Hub sends the status notification for itself and its peripherals. Status The description of the Update process: Completed Failed Not in process 2.2.2 Version Management The purpose of Version Management is to define the hub software version release and track the version updates as they occur. Click Version Management on the Firmware Update dropdown menu to display the Version Management table. Table 3 describes the information about the releases listed in the Version Management table. Table 3: Version Management – Releases Field Name Description Source The upgradeable hub software versions. All versions are backwards compatible. If checked, the upgrade is for a GSM module release. 10 GSM Note: The GSM module upgrade is a firmware over-the-air update. As a result, cellular charges may apply. Target The version presently being upgraded Notes The purpose of the upgrade FTP Path The FTP address, RSU file name, and RSU file location User Name The FTP Server user name Password The FTP Server user password File Size The FTP file size WeR@Home™ Manager User Guide Main Page Field Name Description Retries The number of times the hub tries to download the FTP file. User defined Timeout The total FTP file download time for all download attempts Version Update The date the new hub software version was created, displayed in MM/DD/YY format If checked, the releases are available (published) for firmware/software update. Click this icon to edit a row in the table. Click this icon to delete a row from the table. Click this button to enter information for a new release. Refer to 3 Version Management on page 20. 2.2.3 RSU in Progress The purpose of the RSU (Remote Software Update) In Progress module is to monitor the progress of the version updates of the selected hubs. Since the RSU process can upgrade one or more hubs, the RSU process is managed as a “Batch”. Each batch is assigned an identification number (RSU Batch Id). Figure 6 shows the Firmware Upgrade Batches table that displays the status of the upgrade process of all the batches. Figure 6 – RSU in Progress Table You can drill-down to more detailed information to further explain the status of the RSU upgrade process per batch. WeR@Home™ Manager User Guide 11 Main Page Table 4 describes the information reported in the Firmware Upgrade Batches table, including how to drill-down for more details. Table 4: RSU In Progress – Batches Field Name Description Attributes RSU Batch Id The identification number of the batch of hubs to upgrade via the RSU process Integer No. Panels The number of hubs included in the batch Integer Target Release Version The published target version defined in the Version Management module Format: GSM If checked, GSM module upgraded. Start Date The date and time the RSU upgrade process began [Customer ID].[Release ID] Format: MM/DD/YYYY HH:MI AM/PM + SS:SS Percentage completed Progress The status of the RSU upgrade process Color-coded: Blue – Successful Red - Failed Show Details Click the arrow icon to drill-down to more details about the Batch upgrade process. Hide Details Click the arrow icon to drill-UP to return to summary information of the Batch upgrade process. Click this button to retrieve renewed status information >> Drill-down to Selected Batch Panels Status table << Drill-UP to Firmware Upgrade Batches table Push Button Refer to 4 RSU In Progress on page 25. 2.3. Hub Management The Hub Management module is the central module to the WeR@Home™ Manager application. The purpose of the module is to: 12 Update hub and device firmware and software View all hub information, current and history events Control hub status Issue special commands to the hubs WeR@Home™ Manager User Guide Main Page Set configuration of service level packages for registered hubs Manage HD camera accounts Table 5 describes all the columns in the Hub Management table. Table 5: Hub Management Name Description/Instructions Mark the checkbox for each hub (with its peripherals) that is to be upgraded. <Checkbox> For example, the Update Selected Kits process upgrades the software for the hubs where this checkbox is marked. For information about Update Selected Kits, see page 15. Attributes For Upgrade = checked Not for Upgrade= Unchecked Default: Not for Upgrade= Unchecked Customer The group to which the owner belongs Character Account Id The hub account identification number Integer (8) Serial The hub serial number Hexadecimal Version The internal release number for the software version upgrade 12-character string in format: Place Name The name assigned to the hub, usually describes where the hub is located such as Home or Office. A/N User Name The hub owner name Character Email The hub owner email address Mobile The hub owner cellular phone number Connection Type The type of connection used to connect the hub to WeR@Home™ GSM or Ethernet Hub Status The communication status of the hub Online or Offline nnn.nnn.nnn.nnn The following represent the GSM reception Levels: GSM Level The level of GSM communication currently for the hub, if the hub has a SIM card - Hub without SIM card - Hub with SIM card with No GSM reception - Hub with varying GSM communication levels. Arming Status The arming status of the hub Disarmed or Armed Power Status Whether or not the hub is plugged into a power outlet (mains) Connected or Not connected WeR@Home™ Manager User Guide 13 Main Page Name Description/Instructions Attributes Last Connect Time The last date and time the Hub connected to the Server Format: MM/DD/YYYY HH:MI AM/PM + SS:SS The date and time when First Time Registration for Registration Date the hub was completed Configuration Show Details MM/DD/YY HH:MI AM/PM To assign the WeR@Home™ system service level package to the hub: Refer to 5.1.2 Set Configuration on page 31. Click on to drill down to the Hub Management history information and further hub details, such as registered users and devices. Refer to 5.4 Event History on page 43. Refer to 5.1 Hub Details on page 29. 2.3.1 Filters The Hub Management module provides you with filters to allow you to display only those records that are of interest. Figure 7 shows the basic filter with selection criteria and additional functionality. Figure 7 – Standard Retrieval Filter Table 6 describes the selection criteria fields and the functions of the push buttons in the Standard retrieval filter. Table 6: Filter Criteria and Buttons Name Description/Instructions Attributes Comments <search string> Enter the search string for the filtered retrieval according to the selected search criteria. Character It is required to select search criteria. Owner Name is the default search criteria. Search criteria: Name: Owner name You are required to qualify the search by choosing the search criteria Email: Owner email Mark the button for the search area required. Mobile: Owner mobile Panel Serial: Hub serial number Account Id: Hub account ID 14 WeR@Home™ Manager User Guide Main Page Name Description/Instructions Attributes Comments Click this button to reveal the retrieval options of the more complex retrieval filter. Push Button The encircled DOWN arrow on the button signifies how to switch to the Advanced Search filter. Click this button to clear the selection criteria previously entered. Push Button Click this button to initiate the search according to the selection criteria entered. Push Button Click this button to execute the RSU process for the Hubs with a marked checkbox. Push Button Click this button to create a .htm file of the hubs in the hub management table. Push Button HD Camera MAC Address: Identification of an HD camera At least one checkbox for a selected Hub must be marked. In addition to the standard retrieval filter, you have an additional retrieval filter that allows you to define your search criteria in a more precise manner. Figure 8 shows the additional criteria fields added when using the Advanced Search option. Figure 8 – Advanced Search Table 7 describes the selection criteria fields and the functions of the push buttons in the Advanced Search option. Table 7: Advanced Search Criteria and Buttons Name Description/Instructions Attributes Dropdown Select the status of the hubs you want to be part of the selection criteria: Panel Status WeR@Home™ Manager User Guide The Active and Suspended values filter based on the Current status field. Dropdown list Values are as in image to the right The Online and Offline values filter based on the Connection status. 15 Main Page Name Description/Instructions Attributes Arm Status Select the arming status of a hub you want to be part of the selection criteria. Dropdown list Panel Version Mark one or more Hub Software Versions (not the versions from the Version Management module) that you want to be part of the selection criteria. ZWaveEnabled Mark one or more types of ZWave® Extenders that you want to be part of the selection criteria. Mark one or more Customer Groups that you want to be part of the selection criteria. Group Connection Type Select the type of connection used for the hub to connect to WeR@Home™, as part of the selection criteria. The Retrieval Period is defined as: Last Connected From From date: Chosen date. To date: Current date Choose the earliest Last Connection date as the From Date, for the Retrieval Period. The Retrieval Period is defined as: Registered From From date: Chosen date. To date: Current date Choose the earliest First time Registration date as the From Date, for the Retrieval Period. Dropdown Values are as in image to the right Dropdown list of all released versions listed in the Hub Management module. Multiple selections are allowed. A sample list of the values is in the image to the right Dropdown list of all the types of a Z-Wave® controller. Multiple selections are allowed. Values are as in image to the right. Dropdown list of all customer groups. Multiple selections are allowed. A sample list of the values is in the image to the right. Dropdown list Values are as in image to the right Date in MMM DD, YYYY format: Position the Cursor on the date field. The Calendar mechanism appears, as in the image to the right. Date in MMM DD, YYYY format: Position the Cursor on the date field. Calendar mechanism appears, as in the image to the right. 2.4. Reports The WeR@Home™ Manager allows you to generate HTML reports of hub information and activities. The reports available are: 16 All WeR@Home Registered Panels – Information on all the registered Hubs Panel and Device Status – Information about each Hub and all its devices WeR@Home™ Manager User Guide Main Page Users – Connection information and other profile information about all users for each Hub Recent Events – List of activity that occurred for each Hub during the reporting period Recent Commands - List of commands issued by Hub management for each Hub during the reporting period User Registration – List of first time Hub registration that was completed during the reporting period Suspended Accounts – List of all currently suspended Hubs Account Detailed Activity – Detailed information about all Hub account activity during reporting period Account Activity Summary – Summary of information about Hub account activity during reporting period Service Level History to Days – Number hours the customer used which service level Service Level History to Dates – Period in which the customer used one or more service levels HD Camera Service Level History - The HD camera service level package(s) the customer used for which time period Refer to 6 Reports Management on page 47. 2.5. User Admin The purpose of the User Admin module is to manage user access to the WeR@Home™ Manager application. The master user has full access to all of the capabilities of the User Admin module. The User Admin module allows the master user to: Add a user Edit a user profile Delete a user Table 8 describes all the columns in the main table of the User Admin module. Table 8: User Admin Name Description Attributes Id The number of the row in the table (not part of the data) Integer Email The user’s email for log in purposes Standard email address format First Name The user’s first name Character WeR@Home™ Manager User Guide 17 Main Page Name Description Attributes Last Name The user’s family name Character Mobile The user’s cellular phone number Integer Groups The customer group assigned to the user Default and other Click this icon to Edit the user profile information. Click this icon to Delete the user from the WeR@Home™ Manager application. Refer to 7 User Administration on page 59. 2.6. Panels Registration The Panels Registration module allows you to register multiple hubs and associate the hubs with specific customer groups. When a hub is associated with a customer group, the hub is subject to all the functionality associated with the customer group. Refer to 8 Panels Registration on page 64. 2.7. System Parameters The System Parameters module allows the definition of global system parameters that are used in WeR@Home™. Figure 9 – Instance Information 18 WeR@Home™ Manager User Guide Main Page Caution: This module is for the use of Essence Professional Services personnel only. Refer to 9 System Parameters on page 66. 2.8. View Package Offerings The View Package Offerings module is a reference for assigning the customer’s service level packages in the Hub Management Configuration window. The reference also includes the available configurations for the HD camera service level packages. The reference tables are: Authorization rules by user type and service package Authorization rules by service type Default settings by service package Package Context by HD Camera Package type Refer to 10 View Package Offerings on page 67. WeR@Home™ Manager User Guide 19 Version Management 3. Version Management The Version Management module allows you to manage software releases for the hub and the peripheral devices. The functions allowed in the Version Management module are: 3.1. Add Version Release: Refer to 3.1 Add Version Release on page 20. Edit Version Release: Refer to 3.2 Edit Version Release on page 23. Delete Version Release: Refer to 3.3 Delete Version Release on page 24. Add Version Release Use the Firmware Information form to define a new version of a software release for the hub and its peripheral devices. Figure 10 – Add Version Release 20 WeR@Home™ Manager User Guide Version Management Table 9 provides the instructions for entering the firmware information to add a new version release. Table 9: Add Release Information Field Name Description/Instructions Attributes Source Version: GSM Mark GSM if the upgrade is a GSM module release. Checkbox only Source Version: Version Select one or more of the upgradeable hub software versions. Dropdown list: Values include “ALL” and all the available source versions in format Note: All versions are backwards compatible. Notes Number (7,3). You can choose “ALL” or one or more versions in the list. Target Version Enter the software version to be upgraded. Format: [Customer ID].[Release ID] User Name Enter your FTP Server user name. A/N Password Enter your FTP Server user password. A/N Retries Enter the number of times the hub can try to download the FTP file. Integer: 0 - 9 Required Published Release Note: Not applicable for the GSM module release: Checkbox: Unchecked = Not Published Mark the checkbox if the target version is a Published Release. Unchecked = Not Published Checked = Published Required A version that is not “published” is not available for RSU processing. Timeout Enter the total FTP file download time allocated for all the download attempts combined. Seconds Required Source Port Enter the port used by the FTP Server. Integer Optional ftp://<ftp address>/<file location>/<file name> Required Note: The configuration of the FTP Server determines if a source port is required. Release Location Enter the FTP address, the RSU file location, and the RSU file name. WeR@Home™ Manager User Guide 21 Version Management Field Name Description/Instructions Attributes Notes Seed Note: Not applicable for the GSM module release: Password type (Hidden value) Required Enter the key to the RSU file to enable access for RSU processing Note: The key value is never displayed. Note: If the key value entered does not match the RSU file key (Seed key), the hub rejects the RSU file. Remarks Enter comments about the version update. Free Text Optional Release Notes Note: Not applicable for the GSM module release: Free Text Optional Note: Not applicable for the GSM module release: Checkbox: Unchecked = No Mark the checkbox if the target release file is located on the same server as the WeR@Home™ Manager application. Unchecked = No Enter notes about the version being released. Note: Used by Essence Professional Support Services to enter the link to the Release Notes document. Internal FTP Notify Via Email to: Not in Use Get Emails Not in Use Checked = Yes Click this button to commit, to the database, the new version release and the information entered for the new software version. Push Button Click this button to close the Add Release pane. Push Button When Save is successful, the application closes the window and returns to the Version list. If Save is not successful, an error message window is displayed To add a version release: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click Version Management on the Firmware Update dropdown menu. The Version Management module main page appears. 3. Click Add Release. The Firmware Information form appears. 4. Enter the version release information in the Firmware Information form. 5. Click Save to add the new version release to the Version Management module. 6. Click Close Add Release. 22 WeR@Home™ Manager User Guide Version Management NOTE: If the Firmware Information form is closed without clicking Save, the version release is not added to the Version Management module. 3.2. Edit Version Release The Version Management module tracks the upgradeable hub software version releases currently in WeR@Home™. You can edit the information for any of the versions in the table by clicking . Figure 11 – Edit Version Release The Firmware Information form appears in edit mode. Refer to Table 9 on page 21, for descriptions of all the data fields in the Firmware Information form, used for the Edit Version Release function. To edit the information for an existing version release: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click Version Management on the Firmware Update dropdown menu. The Version Management module main page appears. 3. Click on the row for the version you want to revise. 4. Revise the version release information in the Firmware Information form, as needed. 5. Click Save. WeR@Home™ Manager User Guide 23 Version Management 3.3. Delete Version Release You can delete any of the versions in the Version Management table by clicking Figure 12. , as shown in Figure 12 – Delete Version Release To delete an existing version release: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click Version Management on the Firmware Update dropdown menu. The Version Management module main page appears. 3. Click for the version you want to delete. A delete confirmation message appears, as shown in Figure 13. Figure 13 – Confirm Delete Version Release Request 4. Click OK. 24 WeR@Home™ Manager User Guide RSU In Progress 4. RSU In Progress The RSU In Progress module reports the status of each of the batches of the hubs submitted for software updates. The Firmware Upgrade Batches table allows you to view not only the overall status of a batch update, but also to drill-down to the software update status per hub in a batch. Figure 14 – Drill Down to Show Details 4.1. Selected Batch Panels Status Click Show Details to drill-down from the main Firmware Upgrade Batches table to the Selected Batch Panels Status table. The Selected Batch Panels Status table shows a list of the hubs in the batch. The list shows the status of the software update for each hub. A batch status of the 100% in Blue reports that the software updates for all hubs in the batch are completed and successful. The drill-down to the batch list in the Selected Batch Panels Status table shows additional details that support this conclusion. Table 10 lists the descriptions of the information in the Selected Batch Panels Status table and/or instructions provided about the upgrade process at hub level. Table 10: Selected Batch Panels Status Name Description/Instructions Attributes <Checkbox> Mark the checkbox for each hub that you want to stop the software upgrade process. Stop upgrade = checked Click to stop the software upgrade processing for the hubs with a marked checkbox. Note: At least one checkbox for a selected hub must be marked. WeR@Home™ Manager User Guide Do nothing= Unchecked (Default) 25 RSU In Progress Name Description/Instructions Attributes Panel ID The account identification assigned to the hub Integer Status The last procedure of the upgrade process performed when the process terminated. A/N Step The Step in the last procedure of the upgrade process where the process terminated A/N Error Contact Essence Professional Support Services for clarification. “OK” Progress The status of the RSU upgrade process Percentage completed Color-coded: Blue – Successful Orange - Failed Show Details Click the arrow icon to drill-down to details about the batch upgrade process at peripheral device level. >> Drill-down to Devices in Upgrade table When the batch status is 100% in Orange, the software update was partially successful. The drill-down to the batch list shows additional details that explain this conclusion. For example, Figure 15 below, on page 27, shows a batch which consists of one hub. The details of the software update show the reason why the software update failed: “File system failed to start” The batch list in the Selected Batch Panels Status table allows you to drill-down to the Devices In Upgrade table. The Devices In Upgrade table provides you with additional information per peripheral associated with each hub. NOTE: When the batch status is Orange, contact Essence Professional Support Services if clarification and technical support are required. 4.2. Devices In Upgrade The Devices In Upgrade table provides further details of the upgrade process at peripheral level. In the example in Figure 15, only the software update of one peripheral succeeded. The details at this drill-down level explain the exact step in the update process that failed for each peripheral. 26 WeR@Home™ Manager User Guide RSU In Progress Figure 15 – Devices In Upgrade Table 11 describes the information provided in the Devices In Upgrade table about the upgrade process at peripheral level. Table 11: Drill Down to Peripheral Level Name Device Label Status Step Error Server Command to Panel Progress Description Attributes The name of the device assigned during WeR@Home™ installation Character The last procedure of the upgrade process performed when the process terminated. For information on the status codes, refer to Appendix A RSU Status Logging on page 71. The Step of the last procedure of the upgrade process where the process terminated Contact Essence Professional Support Services for clarification. A/N The last command issued by the Server for execution by the hub Character The status of the RSU upgrade process Percentage completed Color-coded: A/N “OK” Blue – Successful Orange - Failed WeR@Home™ Manager User Guide 27 Hub Management 5. Hub Management The Hub Management module provides you with the tools to manage each hub belonging to your customer base. Refer to Table 5 on page 13 for definitions about the information in the Hub Management table. The tools provide you with the following additional capabilities: View information about each hub Update hub and device firmware and software Control hub status Issue special commands to the hubs Manage HD camera accounts You can drill-down to further details about your WeR@Home™ configuration and history, using the >> Show Details feature. Click the of the hub you want to investigate or manage, as illustrated in Figure 16. The application “drills-down” to more detailed information about the hub, as shown in Figure 17. Figure 16 – Select Hub for Show Details 28 WeR@Home™ Manager User Guide Hub Management Figure 17 – Hub Details 5.1. Hub Details The top part of the Hub Details drill-down level is similar to the table on the Hub Management main page. Table 12 lists the information displayed in the top part of the Hub Details drill-down level, including the commands and the hub status. Table 12: Hub Details and Commands Name Description/Instructions Attributes Customer The group to which the owner belongs Character Account Id The hub account identification number Integer (8) Serial The hub serial number Hexadecimal Version The internal release number for the hub software version upgrade 12-character string in Hyperlink format: Refer to 5.1.1 Hub Version on page 30. nnn.nnn.nnn.nnn Place Name The name assigned to the hub, usually describes where the hub is located such as Home or Office. A/N User Name The hub owner name Character Connection Type The type of connection used to connect the hub to WeR@Home™ GSM or Ethernet GSM Level The current level of the GSM communications for the hub For GSM icons, see page 14. Note: Only for a hub with a SIM card. Arming Status The arming status of the hub WeR@Home™ Manager User Guide Disarmed or Armed 29 Hub Management Name Description/Instructions Attributes Power Status Whether or not the hub is plugged into a power outlet (mains) Connected or Not connected Last Connect Time The last date and time the Hub was connected to the server mm/dd/yy hh:mi AM/PM Registration Date The date and time when the Hub completed its First Time Registration mm/dd/yy hh:mi AM/PM Configuration To assign the WeR@Home™ system service level package to the hub: Refer to 5.1.2 Set Configuration on page 31. Command Select the command to issue to manage the Hub. - appears only when command is selected Hub Management Push Button Click this button to execute the Hub Management command selected. Progress icon The progress bar that represents the running of a process initiated by a Hub Management command Account Status Character The Hub status: Active Suspended Hide Details 5.1.1 Click the arrow icon to drill-UP to return to summary information of the Hub Management module. << Hub Version The version displayed on the Hub Details table is the version of the hub software and GSM module. The window displayed by the hyperlink is the description of the version of the operating system (ESOS) running on the hub. There is a correlation between the version of the hub software and the version of the operating system (ESOS). 30 WeR@Home™ Manager User Guide Hub Management Figure 18 – Panel Version Window NOTE: Hub version details are used only by Essence Professional Services personnel. 5.1.2 Set Configuration The Set Configuration functionality allows you to: Assign a service level package: Service levels are assigned per hub. Users with multiple hubs can have a different service level for each hub. Assign an HD camera service level package per hub with an HD camera Enable or disable monitoring status capability: Monitoring status capability allows you to control whether or not the hub sends messages to the Event Uploader. The service level packages are listed in the View Package Offerings module. Refer to 10 View Package Offerings on page 67. 5.1.2.1 Assigning a Service Level Package To assign a service level to a hub: 1. Open the Hub Management module. 2. Locate the hub for which you want to assign a service level package. 3. Click in the Configuration column. The Configuration window appears, as shown in Figure 19, displaying the current service levels. WeR@Home™ Manager User Guide 31 Hub Management Figure 19 – Configuration Window 4. Click Service Level. The Set Service Level window appears. 5. Select the service level you want to assign to the hub and click Set. 5.1.2.2 Assigning an HD Camera Service Level To assign an HD camera service level to a hub: 1. Open the Hub Management module. 2. Locate the hub for which you want to assign an HD camera service level package, using the filter. 3. Click in the Configuration column. The Configuration window appears, as shown in Figure 19, displaying the current service levels. 4. Click HD Camera Service Level. The Set HD Camera Service Level window appears. 5. Select the HD camera service level you want to assign to the hub and click Set. NOTE: A service level for a hub can be changed using the WeR@Home™ API. 5.1.2.3 Enabling Monitoring Status To enable or disable sending messages to the Event Uploader: 1. Open the Hub Management module. 2. Locate the hub for which you want to assign a service level package, using the filter. 3. Click in the Configuration column. The Configuration window appears. 4. Click Monitoring Status. The Update Monitoring Status window appears. 5. Mark the checkbox to enable the hub’s monitoring capability and click Set. 32 WeR@Home™ Manager User Guide Hub Management 5.1.3 Hub Management Commands The top part of the Hub Details drill-down level provides you with the commands to manage the hubs belonging to your customer base. Figure 20 shows the commands that you can use to manage the hubs. Figure 20 – Hub Management Commands Table 13 describes the information and instructions need to use the Hub Management commands. Table 13: Hub Management Commands Command Suspend Description Suspends user access to the mobile application: The only access to WeR@Home™ is via Arming and Disarming the system using the Remote Control (Key Fob). Instructions Click to execute the command. Purpose Withholding access to applications is the prerogative of the Service Provider. Results Following completion of the Suspend process, the hub status is updated to “Suspended”. Note: Following completion of the Suspend process, the hub status is updated to “Suspended”. Unsuspend Resumes user access to mobile applications Note: Following completion of the Unsuspend process, the Hub status is updated to “Active”. WeR@Home™ Manager User Guide Click to execute the command. Following completion of the Unsuspend process, the Hub status is updated to “Active”. 33 Hub Management Command Description Deactivate Hub Deletes the hub account ID. No data is lost. The server automatically assigns the hub another account ID. Send APN over Ethernet Updates the service provider cellular communications information used by the hub, when the hub has a SIM-card installed. Send APN over GSM Change DNS Updates the Service Provider cellular communications information used by the hub, when the hub has a SIM-card installed. Changes the Web site address to connect to the Server of the WeR@Home™ Refer to 5.1.4 Change Server Procedure on page 36. Reboot 34 Resets the hub by “restarting” (Power Up) the hub Instructions Click to execute the command. Enter the following information and click to execute the command Send APN over Ethernet: APN address User name Password Enter the following information and click to execute the command Send APN over GSM: Number of SIM in hub APN address User name Password Enter the following information and click to execute the command: Purpose Results Renews (resets) communications between the Server and the hub Although the preprogramming of a hub includes all mobile communications methods, there may be missing or out-ofdate information for the GSM cellular service provider in use. This command updates the GSM cellular service provider information. Although the preprogramming of a hub includes all mobile communications methods, there may be missing or out-ofdate information for the GSM cellular service provider in use. This command updates the GSM cellular service provider information. To transfer the WeR@Home™ Hub to another Server Connects the Hub, automatically, to the other Server using the changed DNS New DNS Click to execute the command. To refresh the connection of the hub with WeR@Home™ and its application WeR@Home™ Manager User Guide Hub Management Command Reboot via SMS Description Sends Reboot command by SMS to reset the hub by “restarting” (Power Up) the hub Note: When hub is connected to the Ethernet, send the Reboot command by the internet. Reset to factory Deletes all the data in the Hub relating to the current WeR@Home™ System configuration, such as Rules Users Devices Instructions Enter the following information and click to execute the command: Purpose Results To refresh the connection of the hub with WeR@Home™ and its applications Number of SIM in hub Click to execute the command. To re-initialize the hub inventory and other data, in preparation for reassignment to another customer – requires file transfer The APN and DNS data remains unchanged. Erase all Data from DB Deletes all the data in the server DB associated with the WeR@Home™ hub, by account identification number or serial number. Click to execute the command. Note: The hub status must be “Offline” to allow exclusive access for the DB to delete data. Set WoR Set Access Code Send Logger Command Disable or enable sending a command to the tag reader to trigger the tag reader to emit a countdown warning buzzer Enter the following information and click Disable or enable using tag access code. If enabled, enter access code length. Enter the following information and click For Essence Technical Support only WeR@Home™ Manager User Guide To remove all the data in the server DB associated with a hub that is no longer working with the server. to execute the command: Disable/Enable to execute the command: Disable/Enable Access Code Length (values 4-10) Click to execute the command. 35 Hub Management Command Description Delete HD Camera account The camera account is deleted along with all the HD cameras on the WeR@Home™ network. Send Sirens Volume & Duration Adjust the volume of the sirens and/or the time duration the sirens are sounded, for all the sirens connected to the hub. Instructions Purpose Results Click to execute the command. Enter the following information and click to execute the command: Siren volume: Low, Medium, High, Progressive, and Mute Siren duration: values 5-180 seconds Adjusts the volume and/or the duration of the siren so that the changes are in effect the next time the siren is sounded 5.1.4 Change Server Process The process for moving a hub to a different server requires: Resetting the hub information Reconnecting the hub with its users and peripherals Deleting data 5.1.4.1 Prerequisites To transfer a WeR@Home™ hub to another server, you need to prepare the following: DNS for the server currently running the WeR@Home™ Manager for the hub (Current Server/DNS) DNS for the other server to which you want to transfer the hub (New Server/DNS) Hub serial number Current hub account identification number Note the following before transferring a hub to another server: 36 A hub must be “Online” for all the data for that hub to be deleted from a server DB. When there has been no communication with a hub for at least 20 minutes, the server automatically sets the status of the hub on the Server to “Offline”. The server of the DNS where the WeR@Home™ Manager is running determines where the commands are executed. WeR@Home™ Manager User Guide Hub Management For example, the command Erase All Data From DB deletes all the information in the server DB relating to an “Offline” hub, where the WeR@Home™ Manager application is currently running. The hub account identification number is re-assigned when the hub is “deactivated”. To transfer a hub to another server, the data that associates the hub with the previous server must be removed from both the hub and the previous server. Use commands Reset to Factory and Change DNS for data removal. To perform First Time Registration for a hub, the hub should be cleared of all user definitions. 5.1.4.2 Change Server Procedure The Change Server procedure requires concurrent running of the WeR@Home™ Manager on both the Current Server and the New Server, in separate tabs in your web browser. To change the Server to which the WeR@Home™ hub is connected, perform the following procedure: 1. Log in to the WeR@Home™ Manager application on the Current DNS. 2. Click the Hub Management tab. 3. Click >> for Show Details on the row for the hub for which you want to change the Server connection. 4. Issue the Reset To Factory command to remove data in the hub associated with the Current Server. For information about the Reset To Factory command, see Table 13 above. The hub remains registered on the Current Server. 5. Issue the Change DNS command and enter the New DNS address as per the instructions in Table 13 above. The hub is automatically connected to the New Server via the New DNS. The hub is “deactivated” automatically, assigning a new Account Identification number to the hub, on the New Server. 6. In a separate Web browser tab, log in to the WeR@Home™ Manager application on the New DNS. Click the Hub Management tab. Click >> for Show Details on the row for the hub you transferred to the New DNS, by the Hub Serial number. Verify that the hub is recognized by the WeR@Home™ Manager application on the New DNS. 7. Log in to the WeR@Home™ Manager application on the New DNS and configure the hub on the New Server: Perform First Time Registration for the hub, using the hub serial number. WeR@Home™ Manager User Guide 37 Hub Management Redefine all the users for WeR@Home™, using the Users Admin module. Redefine all the devices for WeR@Home™, using the hub device pairing process. The hub is no longer registered on the Current Server. 5.2. Registered Users Figure 21 – Registered Users for the Hub Table 14 describes the information in the Registered Users table, shown in Figure 21, which lists all the users defined in WeR@Home™. Table 14: Hub Management Users List Name Description Name The user’s first name and family name Email The user’s email address for login purposes The type of user, such as: User Type Master Standard Guard Installer Mobile The user’s cellular phone number Can View Comfort Video If the user profile allows access to comfort videos. Click to enable the helpdesk user to access the end-user's system and account for technical assistance. Support Mode Click account. Click to terminate the helpdesk user access to the end-user's system and to allow the helpdesk user more time for technical assistance. Click this button to re-initialize the user password to the Service Provider-defined default password. 38 WeR@Home™ Manager User Guide Hub Management Click this button to enter the email address to receive the Reset Password link. Click this button to delete either a Guard user or an Installer user, for the professional service package only. Note: This Delete User function is separate from the Delete User function in the User Admin module. 5.3. Installed Devices Figure 22 – Installed Devices Table Table 15 shows the information in the Installed Devices table, which lists all the devices installed in WeR@Home™, managed by the WeR@Home™ hub, identified by the device serial number. Table 15: Hub Management Devices List Name Description Attributes/Values Serial # The internal identification number of the device, extracted by the hub during the pairing process Character Type The description of the device type Character Detection behaviors such as: Status The current detection behavior of the device, when the device is armed WeR@Home™ Manager User Guide Idle Entry/Exit Walk Through Connection loss 39 Hub Management Name Description Attributes/Values CM Support Mode Manage the user access to the HD camera account using the Cameramanager app. Refer to 5.3.1 Using CM Support Mode on page 41. Name/Location The name and/or location entered for the device Alphanumeric Text This refers only to Z-Wave multi-channel devices. The main switch of the device is the parent of the endpoint switches. Parent Name /Location Multichannel Main Switch Multichannel Endpoints The main switch is the parent for the endpoints Additional Info Other information such as association with arming scenarios like Day or Night Arm RF Signal The strength of the Radio Frequency (RF) level of the device Battery Level The battery level for the batteries in the device Version A hyperlink that displays a window with the software upgrade version of the device Character The Device Version, displayed in the Installed Devices table, is the version of the device software. The page displayed by the Hyperlink is the description of the version of the operating system (ESOS) running the hub. The ESOS operating system in this page is represented by: RF Major RF Minor RF Hardware There is a correlation between the version of the device software and the version of the operating system (ESOS). 40 WeR@Home™ Manager User Guide Hub Management Figure 23 – Device Version Window NOTE: Device version details are used only by Essence Professional Services personnel. 5.3.1 Using CM Support Mode The CM Support Mode grants the user access to the HD camera account by providing user credentials for the Cameramanager app. NOTE: Download the Cameramanager app to manage the HD camera accounts. The CM support mode session duration is a pre-defined configurable time of 30 minutes. This duration can be extended or ended early. WeR@Home™ Manager User Guide 41 Hub Management Figure 24 – CM Support Mode To initiate CM Support Mode: 1. Log in to the WeR@Home™ Manager application. 1. Drill down to the Installed Devices table for the hub you want. 2. Locate the entry for the HD camera you want to access. 3. Click Start in the CM Support Mode column. A CM access confirmation window appears. 4. Click Yes to start the CM support mode session. The following session information appears: Expiration date and time of the current session. The username to login to the Cameramanager app, valid only for the current session. NOTE: The password is not displayed. The password is configurable per server. The default password is 123456. Figure 25 – Manage CM Support Mode Session 5. Click End to end the session before the pre-set duration expires. 6. Click Extend to extend the session for another 30 minutes from the current time. NOTE: During the CM support mode session, live or stored videos for the HD camera cannot be viewed. 42 WeR@Home™ Manager User Guide Hub Management 5.4. Event History The Event History page allows you to view all notification messages issued by the hub. Figure 26 – History Hyperlink The history message list includes types of technical message not reported in the WeR@Home™ mobile app, in either the Recent Events pane or the History module. The messages reported in the WeR@Home™ mobile application are filtered to include only those messages of interest to the end user. These message lists are limited to prevent overwhelming the network with unnecessary message traffic. The following is a sample of the additional message types reported in the WeR@Home™ Manager History window: Device temperature Percentage of Battery level remaining Rule Status GSM reception level Device RF strength Z-Wave maintenance event and status Hub capabilities, firmware version, and power status update SIM card availability Network status WeR@Home™ Manager User Guide 43 Hub Management 5.4.1 History Details Figure 27 shows the notification message list of the History window. Figure 27 – History Window Table 16 describes all the information reported in the History window. Table 16: History Information Name Title Line “History of Kit” Description/Instructions Attributes The hub serial number A/N The owner name Character The owner email Standard email address The owner mobile number Integer Select From date using the calendar mechanism Default: Current date Select To date using Calendar mechanism Default: Last – last message issued Refer to 5.4.2 Retrieve History Details on page 45 Calendar mechanism Date in MM/DD/YYYY format Calendar mechanism Date in MM/DD/YYYY format Push Button Date Time format: Time 44 The issue date and time of the notification message MM/DD/YYYY hh:mi:ss AM/PM WeR@Home™ Manager User Guide Hub Management Name Description/Instructions Attributes Event The description of the event Free text Type The device type A/N Name/Location The device name, assigned during system configuration A/N The user who either: Performed the action Used the remote control Used the tag Created a rule Username A/N 5.4.2 Retrieve History Details To retrieve history events using the filter: 1. Click the History hyperlink, as shown in Figure 26 on page 43. The History window appears, as shown in Figure 27. 2. The application automatically retrieves and displays the notification messages issued during the current day. The current day is the default retrieval period. 3. Position the cursor on the From field. The calendar mechanism appears. 4. Figure 28 below illustrates the calendar mechanism to use to define the filter retrieval period. Figure 28 – History Window Filter Scroll through the Month Year using the forward (right) arrow and the backward (left) arrow to locate the From month and year required. Select the From day in the month year selected. 5. Position the cursor on the To field. The calendar mechanism appears. Scroll through the Month Year using the Forward (right) arrow and the Backward (left) arrow to locate the To month and year required. WeR@Home™ Manager User Guide 45 Hub Management Select the To day in the month year selected. 6. Click . The retrieval and display of the contents in the History window, for the new retrieval period, takes about a minute. 7. If you choose an invalid retrieval period, the application displays an error message, as shown in Figure 29: Figure 29 – History Window Filter Error 46 WeR@Home™ Manager User Guide Reports Management 6. Reports Management The WeR@Home™ Manager reports allow you to retrieve information from WeR@Home™ and display this information in a convenient and user-friendly format. WeR@Home™ Manager reports are generated as HTML files, allowing you to use the data for analysis and other purposes. The available reports are: Table 17: Reports Report Name Refer to: All WeR@Home Registered Panels 6.1 Report: All WeR@Home Registered Panels on page 48 Panel and Device Status 6.2 Report: Panel and Devices Status on page 49 Users 6.3 Report: Users on page 50 Recent Events 6.4 Report: Recent Events on page 51 Recent Commands 6.5 Report: Recent Commands on page 52 User Registration 6.6 Report: User Registration on page 53 Suspended Accounts 6.7 Report: Suspended Accounts on page 53 Account Detailed Activity 6.8 Report: Account Detailed Activity on page 54 Account Activity Summary 6.9 Report: Account Activity Summary on page 55 Service Level History to Days 6.10 Report: Service Level History to Days on page 56 Service Level History to Dates 6.11 Report: Service Level History to Dates on page 57 HD Camera Service Level History 6.12 Report: Service Level History to Dates on page 58 WeR@Home™ Manager User Guide 47 Reports Management 6.1. Report: All WeR@Home Registered Panels Figure 30 – All Hubs Report Request The All WeR@Home Registered Panels report provides you with a full list of all registered hubs and information about each hub. Table 18 describes all the information reported in the All WeR@Home Registered Panels report. Table 18: All WeR@Home Registered Panels Data Name Description Group The customer group assigned to the hub owner Panel_ID The account ID assigned to the hub Serial_Number The hub serial number Name The owner first and last name, along with the owner’s email address Mobile The owner’s cellular phone number Arm_State The arming status of the hub at report time Arm_State_Changing_Device_Type The type of device that armed WeR@Home™, such as “RFOutputDevice” Arm_State_Changed_By The assigned name of the device that armed WeR@Home™ Has_Security_Arm Is WeR@Home™ in an alarm state? Security_Alarm_Changing_Device_Type The type of the device that triggered the alarm or disarmed WeR@Home™, the last time the system was in an alarm state. Security_Alarm_Changed_By The assigned name of the device that triggered the alarm or disarmed WeR@Home™ Is_Siren_Sounding Is the WeR@Home™ siren currently sounding an alarm? Last_Communication Not in Use BlackList Not in Use FirmwareVersion The hub software version Panel_Update_Time The last date and time the hub connected to the server Panel_Type_Code The hub communications channel type Role_Id The role assigned to the hub owner Panel_User_id The internal identification assigned to the hub owner. 48 WeR@Home™ Manager User Guide Reports Management 6.2. Report: Panel and Devices Status Figure 31 – Hub and Devices Status Report Request The Panel and Devices Status report provides you with a list of the status of all hubs and their peripheral devices. Figure 31 illustrates how you request a Hub and Devices Status report. Table 19 describes all the information reported in the Hub and Devices Status report. Table 19: Hub and Devices Status Data Name Description Group The customer group assigned to the hub owner Panel_ID The hub account number Name The owner first and last name, along with the owner’s email address DeviceType The type of device HardwareDeviceType The device code Device Name The name given to the device during the registration of the device in WeR@Home™ Pet Immune Is a pet immune lens installed? Is Tampered Is the device in a tampered state? Has Low Battery Is the battery charge of the device low? Day Partition Is the device assigned to the Day Arming scenario? Night Partition Is the device assigned to the Night Arming scenario? Chime Is the MGL configured to act as a Door Chime? Is Open Is the MGL open? FirmwareVersion The software version of the device Last_Communication Not in Use WeR@Home™ Manager User Guide 49 Reports Management 6.3. Report: Users Figure 32 – Users Report Request The Users report provides you with a list of all the users for all the hubs in your customer base. Figure 32 illustrates how you request a Users report. Table 19 describes all the information reported in the Users report. Table 20: Users Data Name Description Group The customer group assigned to the hub owner Panel_ID Hub serial number WeR_UserID The internal identification number assigned to the user by the hub Name The owner first and last name Email The owner email address Role The user type assigned to the user: Master Standard Guard Installer Mobile The owner cellular phone number Mobile Interface iOS or Android mobile and model identification Mobile Version Version of the WeR@Home™ mobile app Asset Version WeR@Home™ server version Is SMS Only Not In Use Create_Time The date and time the user was defined in WeR@Home™ Update_Time The date and time the user was revised in WeR@Home™ Deleted_Time The date and time the user was deleted from WeR@Home™ 50 WeR@Home™ Manager User Guide Reports Management 6.4. Report: Recent Events Figure 33 – Recent Events Report Request The Recent Events report provides you with a list of all the event notifications sent to the hubs in your customer base, during the reporting period. Figure 33 illustrates how you request a Recent Events report. You can enter a reporting period to retrieve events that occurred during a specific time frame. Table 21 describes all the information reported in the Recent Events report. Table 21: Recent Events Data Name Description Event_Id The internal identification number of the event, assigned by the hub Panel_ID The account ID assigned to the hub Name The owner first and last name and the owner email address Event_Code The event type code of the event reported by the hub Event Description The description of the event type code Device_Type Type of hardware device involved in the event Device_Name The assigned name of the device involved in the event Update_Time The date and time the notification of the event was sent to the hub WeR@Home™ Manager User Guide 51 Reports Management 6.5. Report: Recent Commands Figure 34 – Recent Commands Report Request The Recent Commands report provides you with a list of all the Hub Management commands issued to the hubs in your customer base, during the reporting period. Figure 34 illustrates how you request a Recent Commands report. You can enter a reporting period to retrieve commands issued during a specific timeframe. Table 22 describes all the information reported in the Recent Commands report. Table 22: Recent Commands Data Name Description Panel_ID The account ID assigned to the hub Name The owner first and last name and the owner email address Client_Type The client from which the command was issued: Web Mobile Other (The device that triggered/issued the command) Server_Date_Time The date and time the command was received by the server WeRCommand_Code The internal code representation of the command issued Command_Name The name of the command issued, such as: ModifySecurityVideo StopVideo Arm Modify User StartVideo Performed By The user name of the user who was logged on to the client when the command was issued UserId The internal identification of the user who was logged on to the client when the command was issued 52 WeR@Home™ Manager User Guide Reports Management 6.6. Report: User Registration Figure 35 – User Registration Report Request The User Registration reports detailed information per hub in your customer base that was registered during the reporting period. Figure 35 illustrates how you request a User Registration report. You can enter a reporting period to retrieve information about the hubs registered during a specific timeframe. Table 23 describes all the information reported in the User Registration report. Table 23: User Registration Data Name Description Panel_ID The account ID assigned to the hub GroupName The name of the customer group assigned to the hub owner Name The owner first and last name and the owner email address PanelRegistrationDate The date and time that the hub completed the First Time Registration process LastConnected The last date and time that the hub connected to the server 6.7. Report: Suspended Accounts Figure 36 – Suspended Accounts Report Request The Suspended Accounts reports detailed information per hub in your customer base that was suspended during the reporting period. WeR@Home™ Manager User Guide 53 Reports Management Figure 36 illustrates how you request a Suspended Accounts report. Table 24 describes all the information reported in the Suspended Accounts report. Table 24: Suspended Accounts Data Name Description Account_ID Hub account identification number Panel Serial Number Hub serial number Master User Name Owner first and last name Master User Email Owner email address Master User Phone Number Owner telephone number Suspended From The date and time from which access was suspended to the WeR@Home™ mobile application 6.8. Report: Account Detailed Activity Figure 37 – Account Detailed Activity Report Request The Account Detailed Activity reports detailed information per hub in your customer base that was either active or suspended during the reporting month. Figure 37 illustrates how you request an Account Detailed Activity report. You can enter a reporting month/year to retrieve information about the hubs registered during that timeframe. Table 25 describes all the information reported in the Account Detailed Activity report. 54 WeR@Home™ Manager User Guide Reports Management Table 25: Account Detailed Activity Data Name Description Account ID Hub account identification number Group Name Owner (customer) group Panel Serial Number Hub serial number Plan Service contract with your service provider: Basic or Premium Master User Name Owner first and last name Master User Email Owner email address Master User Phone Number Owner telephone number Days In Month Total number of days in the reporting month Days Suspended Number of days in the reporting month that the hub was suspended or inactive Days Active Number of days in the reporting month that the hub was active Registration Date Date and time that the hub completed the First Time Registration process Notes Free Text 6.9. Report: Account Activity Summary Figure 38 – Account Activity Summary Report Request The Account Activity Summary reports summary information about hubs in your customer base that were either active or suspended during the reporting month. Figure 38 illustrates how you request an Account Activity Summary report. You can enter a reporting month/year to retrieve information about the hubs registered during that time frame. Table 26 describes all the information reported in the Account Activity Summary report. Note that an activated hub is a hub that is connected to the server and not necessarily registered with WeR@Home™. WeR@Home™ Manager User Guide 55 Reports Management Table 26: Account Activity Summary Data Name Description Group Name Owner (customer) group NumberOfPanels Total number of active hubs at the time of the reporting month SuspendDays Total number of days active hubs were suspended in the reporting month SuspendedPanels Number of active hubs that were suspended in the reporting month 6.10. Report: Service Level History to Days Figure 39 – Service Level History to Days Report Request The Service Level History to Days report displays the number hours the customer used each of the service levels within a given timeframe. The selection criteria include a date range that defines the given timeframe, as shown in Figure 39. A Service Level History to Days report is displayed as an HTML report based on a .csv file. Table 27: Service Level History to Days Data 56 Name Description Account ID Hub account identification number Serial Hub serial number Registration Time Date and time the hub was registered with WeR@Home™ Current Package Current assigned service level Days In Free Package The number of days the customer used the basic service level Days In Premium Package The number of days the customer used the premium service level WeR@Home™ Manager User Guide Reports Management Name Description Days Suspended The number of days the customer was suspended from service Hub Group The assigned distribution group 6.11. Report: Service Level History to Dates Figure 40 – Service Level History to Dates Report Request The Service Level History to Dates report displays the period in which the customer used one or more service levels. The selection criteria include a date range that defines the given timeframe, as shown in Figure 40. A Service Level History to Dates report is displayed as an HTML report based on a .csv file. Table 28: Service Level History to Dates Data Name Description Account ID Hub account identification number Package Assigned service level Start Date Date and time the hub began working within the assigned service level End Date Date and time the hub stopped working within the assigned service level WeR@Home™ Manager User Guide 57 Reports Management 6.12. Report: HD Camera Service Level History Figure 41 – HD Camera Service Level History Report Request The HD Camera Service Level History report displays the period in which the customer used one or more HD camera service levels. The selection criteria include a date range that defines the given timeframe, as shown in Figure 41. A HD Camera Service Level History report is displayed as an HTML report based on a .csv file. Table 29: HD Camera Service Level History Data 58 Name Description Account ID Hub account identification number Package Assigned HD camera service level Start Date Date and time the HD camera began operating within the assigned service level End Date Date and time the HD camera stopped operating within the assigned service level WeR@Home™ Manager User Guide User Administration 7. User Administration The User Administration (User Admin) module allows you to manage the users of the WeR@Home™ Manager application. The module provides you with the following functionality: Add User Edit User Delete User 7.1. Accessible Modules Figure 42 – Accessible Modules Managing the users includes defining each user’s access to the WeR@Home™ Manager application. Each user should be granted “access” to the various modules in the application, according to the capabilities the user requires to manage WeR@Home™ installations of their customer base. Each user is granted access to all or part of the WeR@Home™ Manager application. In general, full (Read/Write) access is granted at module level within the application. Since the Hub Management module includes issuing commands and running processes that affect the data in the hubs and in the servers, access to the Hub Management module is limited. For example, for a user to have full access to the Hub Management module, the following Accessible Modules must be marked: Hub Management – Access without capability to issue Suspend Panels and Remote commands Suspend Panels – Suspend panels capability Remote Commands – Remote commands capability WeR@Home™ Manager User Guide 59 User Administration Table 30 below lists the options available to define access to the WeR@Home™ Manager functionality. Table 30: Accessible Modules Name Capabilities Reports Run all reports, generating Excel files Hub Management Update kits, export data to Excel files, assign service level packages, and manage the hubs Important Notes Access to this module does not include the privilege to suspend/unsuspend hubs. Firmware Update Update hub and peripheral software modules User Administration Add, edit, and delete users Panels Registration Run batch processes to register hubs and associate them with customer (owner) groups Suspend Panels Suspend or unsuspend access to the WeR@Home™ application This option grants the user the privilege to suspend/unsuspend hubs in the Hub Management module. Remote Commands Manage hubs via remote access to WeR@Home™ This option allows the user to issue commands, in the Hub Management module, from a remote location. The hub is not connected via a USB to the user’s computer. System Parameters Update global system parameters that control and manage WeR@Home™ operations This module is for Essence Professional Services personnel only. View Package Offerings This references the View Package Offerings tab, which is a read-only page that displays the authorization rules for the service level packages by user type. 60 Grants the users full or partial access to the WeR@Home™ Manager application WeR@Home™ Manager User Guide User Administration 7.2. Add User This Add New User link displays the User Information page that allows you to enter a user’s personal information required for the WeR@Home™ Manager application. Figure 43 – Add User Table 31 describes the information required to add a user to the WeR@Home™ Manager. Table 31: Add User Information Name Description Email Enter the user’s email address that is used as the user identification during log in. Password Enter the user’s password. Confirm Password Enter the user’s password again for confirmation purposes. First Name Enter the user’s first name. Last Name Enter the user’s family name. Mobile Phone Enter the user’s cellular phone number Select the date format preferred by the user for the dropdown list: Date Format Groups WeR@Home™ Manager User Guide Select the customer group, Default or another group, to which the user will belong. 61 User Administration Name Description Select one or more modules to which the user will have FULL ACCESS: Accessible Modules For more information about module access, see section 7.1 Accessible Modules on page 59. Click this button to add the user to the WeR@Home™ Manager application, saving the user’s personal information and access definitions. Click this button to stop the addition of a user to the WeR@Home™ Manager application. To add a new user: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click User Admin module. The User Administration module main page appears. 3. Click Add New User. The User Information page appears 4. Enter the user personal information, including configuring the user’s access to the WeR@Home™ Manager modules. 5. Click Save. 7.3. Edit User The Edit User functionality allows you to edit the personal information for an existing WeR@Home™ Manager user. Figure 44 shows the page for editing an existing user. You can edit the information for any of the users in the table, including altering access to the WeR@Home™ Manager modules. For descriptions of all the data fields in the Edit User page, see Table 31 on page 61. Figure 44 – Edit User To edit the personal information for an existing user: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click User Admin. The User Admin module main page appears. 62 WeR@Home™ Manager User Guide User Administration 3. Click for the user you want to edit. The User Information page appears. 4. Edit the user information as needed. 5. Click Save. 7.4. Delete User The Delete User functionality allows you to remove an existing user from the WeR@Home™ Manager application. Guard and Installer users per hub can be deleted only in the Registered Users matrix in the Hub Management module. Refer to section 5.2 Registered Users on page 38. Figure 45 shows the User Admin table displaying the list of the existing users. Figure 45 – Delete User NOTE: The administrator user (admin) cannot be deleted. To delete an existing user: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click User Admin. The User Admin module main page appears. 3. Click the delete icon for the user you want to delete. The Delete User functionality DOES NOT include confirmation of the delete user request. Caution: When you click Delete User, the user is immediately deleted. WeR@Home™ Manager User Guide 63 Panels Registration 8. Panels Registration The Panels Registration module allows you to define a list of hubs that require group association. The purpose of the Panels Registration module is to allow you to manage your hub inventory, by assigning the hubs to groups and then managing the groups of hubs. For example, you can define customer groups that represent the distribution of the hubs for sale through numerous retail outlets. Each outlet is assigned a group number. When a number of hubs are selected to be distributed to a specific retail outlet, you can use the Panels Registration module to “register” the hubs as “associated” with the specific retail outlet. In this way, you can track the hubs as they are sold by the retail outlet. NOTE: This functionality is available only to hubs that have not yet been registered. Figure 46 shows the Panels Registration page. You are prompted to choose a file with the list of hubs for registration. Figure 46 – Panel Registration By clicking 64 , each hub listed in the file is: Assigned to a customer group, by hub serial number. Given an account number when the hub connects (even briefly) with the server. Paired with one or more devices, adding the device information to the hub peripheral device inventory. WeR@Home™ Manager User Guide Panels Registration Table 32 describes the input file structure required for the Panel Registration process. Table 32: Panel File Structure Name Description Serial The hub serial number Group Identification number for the customer group to which the hub will belong NOTE: Contact your WeR@Home™ Manager administrator to get the customer group identification numbers. To run the Panel Registration process: 1. Log in to WeR@Home™ Manager. The WeR@Home™ Manager home page appears. 2. Click Panels Registration. The Panels Registration module main page appears. 3. Click Choose File. Your browser window appears. 4. Select the Excel (.csv) file which contains the list of hubs for registration, required for the Panel Registration process. 5. Click Import to DB. The Panel Registration process is executed using the file chosen in the previous step. The results of the Panels Registration process are displayed on the Panels Registration page, as illustrated in Figure 47. For example, in Figure 47, one hub in the list, in the panel registration file.csv, did not register successfully because the serial number for the hub was already registered. Figure 47 – Results of Panel Registration Process WeR@Home™ Manager User Guide 65 System Parameters 9. System Parameters The global system parameters are used in many aspects of the infrastructure and configuration of WeR@Home™. These parameters are crucial to maintaining optimum WeR@Home™ system operations. Caution: It is not recommended for customers to have access to this module. Incorrect use of these parameters can have a negative effect on system operations and jeopardize data integrity. To prevent customer Admin users from modifying system parameters: Do not mark the System Parameters checkbox in the Accessible Modules option, when adding or editing the Admin user profile, in the User Admin User Information form. Refer to 7.2 Add User on page 61. Table 33 includes a list of the system parameters. Table 33: System Parameters Category WeR@Home™ system parameters Parameter Ag Server Parameters Arming Exit Delay August Lock Parameters Cache Configuration Settings Cameramanager default EUP EUP Ifttt Filter EUP Ifttt Transmitter EUP subscriber Event Uploader IFTTT IFTTT Bulb Color IFTTT Set Z-Wave Switch IP Camera Mail Configuration Settings Nest Parameters Password Policy Configuration files parameters 66 Password policy validation Password Reset TR5 Access Code WeR Manager (Back Office) WeR@Home™ Manager User Guide View Package Offerings 10. View Package Offerings In the Hub Management module, you can configure the service level packages for your customer hubs, using the configuration functionality. Refer to section 5.1.2 Set Configuration on page 31. To understand the settings for each of the different service level packages, the View Package Offerings module provides you with the information you need to assign the appropriate service level to each customer. The tables below constitute the rules and context reference information provided by the View Package Offerings module. Table 34: Authorization Rules by User Type and Service Package Authorization Rule Description Notes Manage Security Tag Devices Adding tags to tag readers including assigning the owner to each tag Without an access code per tag Manage Security Devices, except Tag Adding a security device except for a tag reader Any security device such as a camera detector, motion detector, or door/window sensor Pair / change Guard Tags with Access Code Adding a tag with an access code for a guard user Manage Z-Wave Devices Adding, update, and removing Z-Wave devices Only for master users Control Z-Wave Devices Controlling Z-Wave devices For all users Arm/Disarm Allowing to arm or disarm any device Arming includes full, night, day, and force arming Comfort Video Allowing to initiate and view comfort videos Recorded by either camera detectors or HD cameras Security Video Allowing to view security videos recorded by camera detectors Max Days View Log Number of days back allowed to view history events Manage Rules, except Schedule Trigger WeR@Home™ Manager User Guide Adding, editing, and removing all rules except rules with scheduling triggers If an existing rule has both a scheduling trigger and a device trigger, the scheduling trigger must be removed to manage the rule 67 View Package Offerings Authorization Rule Description Notes Manage Rules, only with Schedule Trigger Adding, editing, and removing rules with only scheduling triggers If an existing rule has both a scheduling trigger and a device trigger, the device trigger must be removed to manage the rule Manage Shortcuts Adding, deleting, or moving shortcuts Manage Users Adding, deleting, or editing user profiles Standard users have view access only Remove 1st Master Removing the master user used for first-time registration Only if there is more than one master user defined Other Master Actions Privileged actions granted to master users; Refer to the user level comparison table in the Managing Users section in the WeR@Home™ User Guide. Comparison between master and standard user levels only View Any Video Allow viewing videos in the Video gallery Show or hide videos Manage Emergency Contact Adding, deleting, or editing Emergency Contact information For master user with professional monitoring package View Emergency Contact Allow read-only access to the Emergency Contact information For user with professional monitoring package Allow 'Safety' e-mail Notifications Allow 'Safety' SMS Notifications Allow 'Safety' Push Notifications Allow 'System' e-mail Notifications Allow 'System' SMS Notifications Allow 'System' Push Notifications Allow 'Comfort' e-mail Notifications Enable or disable the option in the Users profile for sending notifications to users via the following media: E-mail SMS Push If enabled, option appears in Users profile screen. If disabled, option does not appear in Users profile screen. Allow 'Comfort' SMS Notifications Allow 'Comfort' Push Notifications Smoke Cannon Allowing the master to grant permission to other users to fire the smoke cannon. If disabled, appears Grey. Pet Immune Allowing the installer to confirm if a pet immune lens was installed in a motion detector or a camera detector. If disabled, appears Grey. Manage Nest Devices Adding, controlling, and removing only Nest devices Control Nest Devices Controlling Nest devices Manage HD Camera Devices Adding, controlling, and removing only HD cameras Control HD Camera Devices Controlling HD Cameras 68 WeR@Home™ Manager User Guide View Package Offerings Authorization Rule Manage August Devices Control August Devices Description Notes Not in use Future feature Table 35: Authorization Rule Limits by Service Type Authorization Rule Description Notes Max Master Users The maximum number of master users allowed Default: 3 Max Standard Users The maximum number of standard users allowed Default: 32 Max IPD Devices The maximum number of cameras detectors allowed Default: 8 Allow Installer Role Service types allowed to assign the installer role Allow Guard Role Service types allowed to assign the installer role YesProfessional No - DIY YesProfessional No - DIY Allow Only Non Schedule Rules Not in use Max Emergency Contact The maximum number of emergency contacts allowed The following table defines the settings for the toggle switch Default: 4 YesProfessional No - DIY in the mobile app: Table 36: Default Toggle Settings Settings Description Default Master Notification Settings Defines default settings, in the Users profile, for sending notifications to users via the following media: Default Standard Notification Settings Default Installer Notification Settings Default Guard Notification Settings Notifications Filters Moved To Cellular Backup Channel Notifications Filters No Sim Inserted Or Sim Not Ready Smart Rules End Date Smart Rules End Time Smart Rules Full Day WeR@Home™ Manager User Guide E-mail SMS Push Default setting for the System Information filters Default setting for schedule rules’ definitions Default setting for arm rules with schedule rule definitions 69 View Package Offerings Settings Description Smart Rules Trigger Temperature Detected By Default setting for higher or lower temperature for PIR or IPD devices in the event rules Smart Rules Trigger UTS Only for a universal transmitter connected to a security device. Smart Rules Trigger Switch Default setting for a smart switch selected as an event trigger Smart Rules Action Record Video Default setting for a camera detector selected as an action Smart Rules Action Siren Default setting for a siren selected as an action Smart Rules Action LED Bulb Default setting for a RGBW LED Bulb selected as an action Smart Rules Action Switch Dimmer Default setting for a dimmer, acting as a switch, selected as an action History Filters Default settings for the filters to include or not include history events in the initial display User Can View Comfort Video Default setting to allow or not allow users to view comfort videos. Emergency Contacts Call Before Making 911 Call Default setting to allow or not allow users to list contacts to call before calling 911. HD Camera Video Transmission Default setting of Custom (On) or Private (Off) for running and capturing live videos User Can Access Smoke Cannon Default setting to allow or not allow the Master to grant permission to fire the smoke cannon. MIMO Input Output Endpoints Default thresholds for the MIMO input endpoints Default settings for the MIMO output switches For the Installer user only: Pet Immune Default setting to confirm if a pet immune lens is installed in a motion detector or a camera detector August Lock Notifications Not in use – Future feature Table 37: Package Context by HD Camera Package Type Context Description Account ID The Cameramanager account ID assigned to a service package Maximum Cameras The number of HD cameras allowed for the Cameramanager account ID Storage Hours The number of video storage hours allocated per camera for the Cameramanager account ID 70 WeR@Home™ Manager User Guide RSU Status Logging Appendix A RSU Status Logging The hub version may be upgraded via an administered RSU process, invoked via the WeR@Home™ Manager application. During the process, the RSU status is written to the main Everguard database. To identify the RSU tables, the table names in the database are prefixed with "RSU_". RSU events sent from a hub to the server are parsed and stored in the RSU_Log_Events table. The following is a list of RSU status codes: RSU_STATE_ERASE_SECTORS RSU_STATE_GET_RSU_FILE RSU_STATE_CHECK_RSU_FILE_CRC RSU_STATE_START_RSU RSU_STATE_GET_MODULE_FILE_HEADER RSU_STATE_UPDATE_EXT_CONTENT_TABLE RSU_STATE_UPDATE_RSU_PARAMS RSU_STATE_READ_EXT_CONTENT_TABLE_AFTER_RESET RSU_STATE_INIT_TASK_AFTER_RESET RSU_STATE_UPDATE_MEM_MAP_PARAMS RSU_STATE_UPDATE_FAT_TABLE RSU_STATE_READ_FAT_TABLE RSU_STATE_MODULE_UPGRADE_PROCESS RSU_STATE_MODULE_FIRST_READ RSU_STATE_WAIT_FOR_MODULE_PROCESS RSU_STATE_CLEAR_DEVICE_MANAGER_BITS RSU_STATE_WAIT_FOR_READY_SYSTEM_CONDITIONS RSU_STATE_UPDATE_END_PROCESS WeR@Home™ Manager User Guide 71 Legal Notice Legal Notice Usage of this document, and all information (including product information) provided within, are subject to the following terms and conditions, and all applicable laws. If you do not agree with these terms, please do not access or use the remainder of this document. This document contains highly confidential information, which is proprietary to Essence Security International (E.S.I.) Ltd. and/or its affiliates (hereafter, "Essence"). No part of this document's contents may be used, copied, disclosed or conveyed to any third party in any manner whatsoever without prior written permission from Essence. The information included in this document is intended for your knowledge and for negotiation purposes only. Essence makes no implicit representations or warranties with respect to such information. The information included in this document is subject to change without notice. Any decision to rely on the information contained herein shall be at your sole responsibility, and Essence will not accept any liability for your decision to use any information or for any damages resulting therefrom. Certain laws do not allow limitations on implied warranties or the exclusion or limitation of certain damages. If these laws apply to you, some or all of the above disclaimers, exclusions, or limitations may not apply to you. By using the information contained herein, you agree that the laws of the State of Israel, without regard to principles of conflict of laws, will govern any dispute of any sort that might arise between you and Essence regarding the information contained herein, and any such dispute shall be settled exclusively in the competent courts of Tel Aviv-Jaffa, Israel. All registered or unregistered trademarks, product names, logos and other service marks mentioned within this document are the property of Essence, or their respective owners. Nothing contained herein shall be construed as conferring by implication, estoppels, or otherwise any license or right, either express or implied, under any patent or trademark of Essence or any third party. No use of any trademark may be made without the prior written authorization of Essence. This document and all of its contents are protected intellectual property of Essence. Any copying, reprinting, reuse, reproduction, adaptation, distribution or translation without the prior written permission of Essence is prohibited. Please check your End User License Agreement (EULA) for terms and conditions. © 2017 All rights reserved to Essence Security International (E.S.I.) Ltd. For more information, please contact: Essence Security International (E.S.I.) Ltd. 12 Abba Eban Avenue, Ackerstein Towers Bldg. D Herzliya Pituach, 4612001 Israel www.essence-grp.com 72 Tel: +972-73-2447777 Fax: +972-9-7729962 WeR@Home™ Manager User Guide
© Copyright 2026 Paperzz