026-1012 Rev 3 06-DEC-2011 Site Manager User Manual
Retail Solutions 3240 Town Point Drive NW Suite 100 Kennesaw, GA 30144 Phone: 770-425-2724 Fax: 770-425-9319
Table of Contents 1 OVERVIEW ................................................................................................................................................................... 1 1.1. WHAT SITE MANAGER CAN DO ................................................................................................................................... 1 1.2. BASIC CONCEPTS .....................................................................................................................................
3.2.3.1. View History..................................................................................................................................................................... 24 3.2.3.2. Configure Purge ................................................................................................................................................................ 26 3.2.4. Schedule Manager.............................................................................................................
5.1. FIRMWARE PACKAGE MANAGEMENT ......................................................................................................................... 5.1.1. Add Firmware ..................................................................................................................................................... 5.1.2. Delete Firmware ................................................................................................................................................. 5.2.
9.2.6. Working With Widget Parameters....................................................................................................................... 87 9.3. GS SCREEN ACTIONS.................................................................................................................................................. 87 9.3.1. Exporting the GS .ZIP ......................................................................................................................................... 87 9.3.2.
1 Overview Site, Control System, and Unit, and use the Search option (see Section 1.2.1., Search Criteria) for locating items in Site Manager. Site Manager features include: 1.1. What Site Manager Can Do Site Manager helps you manage and monitor site information and activities by giving you fast, remote access and intuitive navigational tools. It also allows users to gain immediate access to data for performing and configuring site activities for superior task control and site management.
Sites To search for a site, the following criteria can be entered: Name of site (numerics are supported: for example, you can search for “Store Name 10”, even if the actual name is “Store Name 00010”), city, state code, state name, country code, country name. Control System To search for a control system, the following criteria can be entered: Name of control system, protocol, IP Address, site alias. Unit To search for a unit, the following criteria can be entered: Name of the unit, type, firmware version.
Prefix Search Scope revision limits searches to unit version protocol limits searches to protocol names ip limits searches to IP addresses Table 1-1 - Allowed Prefixes to Narrow Down Search Criteria NOTE: A prefix cannot be used with another. For example, the following is not supported: contractor:name:Robert 1.4. Login/Logout 1.4.1. Login The login page is the first page that appears on your web browser (Figure 1-1).
To retrieve a password that has been forgotten, click on the Forgot Password? link to open a special ID window (Figure 1-2) where you can enter your login ID and have your password sent to the e-mail address associated with your login ID. 1. Enter your valid e-mail address and click Send. 2. Your login ID(s) will be sent to the e-mail you entered.
1.5. Site Manager Interface The Site Manager page (Figure 1-6) is where you will find the navigation tree, navigation window, menu bar, and the main window. Figure 1-6 - Site Manager Interface Page drop-down list for the appropriate point view.
of all directories, sites, units, and control systems. • Navigation Window - The main window of the navigation tree. • Hide Navigation Frame - Collapses or hides the navigation window from view, allowing for maximum viewing room of the main window. Click on and units. The applications are located next to the box icons, with any application instance listed underneath the box next to the application instance icons. Application instance are user-defined and can be of one or more in quantity.
1.5.3. Menu Bar Depending on licensing and the assigned user level, the menu bar gives you access to menu items such as Pending Activities, Activity Histories, Groups, and online help: Figure 1-8 - Menu Bar • To access your Pending Activities and your Activity History, click on My Info for the drop-down menu. • To access Groups, click on Admin Tools for the drop-down menu (this menu can only be accessed by admin level users).
2 IT Administrator Functions 2. Click the Registration button to proceed in obtaining a license. 2.1. Feature Licensing and Registration Site Manager has basic and extra features that are activated by obtaining a license. To obtain trial and other licensing, you must first register the software. A license key must be entered to activate the desired feature.
Company Name, Address, Name, E-mail, Confirm E-mail, and a contact Phone Number. If desired, enter any extra information into the Additional Information box (optional). Note that for non-SMTP enabled systems, you must specify if the Web application is a virtual machine by selecting Yes or No for Virtual Server. Verify that the information you entered is correct and click the Submit Registration button. 6. Click OK and you will return to the Feature Licensing page.
2. Click OK on the confirmation window to proceed. • Step 1 - Create an e-mail and include all the information listed in this step. • Step 2 - Enter SolutionsLicensing@emerson.com in your e-mail's To: field. • Step 3 - In the Subject: field of your e-mail, enter Site Manager Product Activation License SO# (followed by the Sales Order number obtained from customer service). • Step 4 - Open your browser window and locate the directory that contains the.
The Product Activation License Update window will open (Figure 2-12). Click the Add Feature button on the Feature Licensing page and enter the key into the boxes provided (Figure 2-13). Figure 2-12 - Product Activation License Update Page 6. Once the Apply Imported License button is clicked, the selected license file will be applied (or click Cancel to stop and exit). 2.1.3.
For features such as backing up, sending reports, forwarding and viewing advisories, setpoint broadcast, accessing the online help system, firmware transfer, and more, a Site Manager license is needed for activation. Additional plug-in features will need specified keys for operation. Contact Retail Solutions (770-425-2724) with your Hardware Fingerprint information for acquiring the license key. Contact Technical Support for instructions on entering keys.
instructions for importing the XML file. (The XML import tool can be run as many times as desired and will only import new sites and directories. To run it more than once or to run it outside of this installation, view the XML import directions found at the path listed above.) 2.4.2.
3 Menus 3.1. My Info Menu 3.1.1. About User Info The My Info drop-down menu contains a list of features that consists of anything that pertains to “personal items”, your user info, pending activities, activity history, and when applicable, saving a GS Screen as your system home page. abled, the GS menus will become visible on the right-click Navigation Tree menu. Click the Save button at the bottom of this page and refresh the Navigation Tree for changes to take effect.
3.1.3. My Pending Activities The My Pending Activities - Results page shows the activities that you, the current user has been waiting to start or that are in progress, and also shows activity status. My Pending Activities is found under My Info on the menu bar. Figure 3-4 - My Activity History - Results Page Figure 3-3 - My Pending Activities - Results Page • Activity: An activity that is scheduled to start or currently being performed.
Click the down arrow that appears next to a column header to show more columns or enable sorting options: You can also choose to export all details of the activities by clicking the checkbox. Click the Export button to begin the download. Figure 3-6 - My Activity History -Results Export Options On the File Download window, click Open or Save to continue with the download. NOTE: Only the columns currently shown on the page will be exported during file download.
3.2. Admin Tools Menu 3.2.1. Setup 3.2.1.1. User Manager The User Manager lists all users in the database. From the User Manager page you can select a user to edit, delete a user, or jump to the User Configuration page to add a user. Site Manager Setup is found under Admin Tools on the menu bar.
Click Open or Save on the File Download window to proceed with the download. Adding a New User To add a user, click the Add New button from the User Manager page and enter the information into the fields on the User Configuration page, refer to Figure 3-11. Changing User Passwords: Reset user passwords by enabling the Change Password checkbox and entering the new password. Retype the new password again and enter a password hint for password recovery. Click Save.
Deleting a User Delete a user by selecting the username (Administrator excluded) and clicking Delete. A confirmation window will open asking if you are sure you want to delete the user. Click the Group Name header for a quick sort or click the drop-down arrow to open the sort menu: Figure 3-14 - Group Name List Sorting To export group data, select from the available export formats from the drop-down below the table: Excel Spreadsheet, HTML, and PDF. Figure 3-12 - User Configuration Page - Delete User 3.
Editing a Group View the list of all groups from the Group Manager page (Figure 3-16) and select the desired group name. Click Edit and the Group Configuration page will open where you can enter changes. Name the new Group by entering it into the Group Name field, then select the desired access level from the Protocol Access Level drop-down list. These levels are dependent on privileges that have been set in the controller, and determine what actions the user can perform.
Click Save to save the new Group and its privileges and go back to the Group Manager page. Click Cancel to exit without saving and go back to the Group Manager page. Click the Directory header for a quick sort or click the drop-down arrow to open the sort menu: Required fields: Group Name and at least one privilege. Site View Permissions: You can assign permissions (which directories and sites) to each Group by enabling the checkboxes next to them.
Configuring Directory Information 3.2.1.4. Site Manager Add or edit a new directory from the Directory Configuration page. Edit the directory information by changing the current information in the fields, or by entering new information for a new directory in the fields. If United States is selected as the country, a drop-down menu with all the states will be shown.
with all the states will be shown. If another country is selected, the State/Province/Region drop-down menu will be changed to a blank text field to allow a name to be entered in the field. Click the Save button to save and the Cancel button to return to the Site Manager page. The Site Configuration page is also available from the right-click/mouse-over Add Site and Edit Site menus at the Directory or Site levels in the navigation tree.
field to allow a name to be entered in the field. Click Save to store changes and Cancel to exit without saving and return to the Contractor Manager page. 3.2.2. Pending Activities The Pending Activities - Results page shows the current activities that users have waiting to start or that are in progress, and also shows activity status. Pending Activities is found under the Admin Tools menu on the menu bar.
Activity History - Results at the administrator level shows a complete history of activities performed, including such information as the type of activity that was performed, start and finish times, duration of the activity, user information, and more. view by Result type. • Exceptions Report - Click the Exceptions Report icon from this column to open a window that displays details of the activity that was either failed or partially completed.
To access the Schedule Manager page, click Schedule Manager from the Admin Tools menu. The page will show a table that lists all the scheduled activities based on server’s time zone. Figure 3-32 - Admin Activity History Menu from Navigation Tree 3.2.3.2. Configure Purge Activity History data is stored in the database but can be deleted with the Configure Purge feature.
used in Activity History. The status may be clicked on to view the detailed activity history for that schedule. The status will be linked to the most recent activity history that is attached to the schedule and has not been purged. If the schedule has not run yet, Last Status will be left blank.
Schedules can also be based on an interval (select the Interval Based option): 3.2.4.2. User Schedules Scheduling Setpoint Broadcast When store hours change or special events occur, scheduling a Setpoint Broadcast can send data to multiple groups, sites, and/or multiple controllers at one site, and provides the ability to send setpoint and parameter information across a single enterprise. To schedule Setpoint Broadcast, refer to Section 3.3.2., Setpoint Broadcast.
Click the Power Builder link to open the List Power Builder window. For scheduling Refresh Point List, enter a name and choose whether refreshing the point list should be run now or on a schedule. Select the type of Schedule (one-time only, at intervals, or calendar-based). Figure 3-41 - Scheduling Refresh Point List Scheduling Backup Figure 3-40 - Scheduling Retrieve Logs From List Scheduling Refresh Point List Refresh point list is an activity that may be performed at a control system level.
Scheduling Obtain Controller Information The Obtain Controller Information activity connects to a given Control System, refreshes the Unit list, refreshes the Application List for each Unit, and refreshes the points for any Application Instances that have “out of date” points, which means the point list will be retrieved for any applications that have never had a point list retrieved, and also for any applications that have changed since the last time the point list information was checked.
ter Rules List when retrieving logs for directories, sites, control systems, or units. This will configure the Retrieve Log activity by filtering which logs you wish to retrieve. Select the applications by enabling the application checkboxes and clicking Go. If you wish Site Manager to retrieve logs automatically at a specified time for each day, enable the Run On Schedule option you will be directed to the Schedule Manager page. Enable the Run Now checkbox if you wish to retrieve logs now.
3.3.1.3. Advisory Forwarding Running Setpoint Broadcast on a schedule With the Advisory Forwarding feature, advisories can be forwarded to an email address. See Section 6.2.3., Advisory Forwarding for more information about advisory forwarding. Enter unique name for each setpoint broadcast in the Name field. You will be notified if the name already exists in the database and prompted to rename the broadcast before you can save. This field cannot be left blank. 3.3.2.
If either option is selected, the notification can be configured. Two notification options are available: • Pop-up: A popup message will open if you are logged into the system at the time the message is sent out. The message will include the name of the schedule, type, user, and status. Click OK to close the pop-up. next to the Test Send checkbox will notify the users that selecting the checkbox will not actually send the values.
point Groups). Figure 3-52 - Application Setpoint Group Screen Give the group a unique name. (You will be prompted if the name entered matches an application setpoint group already in the database.) Choose a type of schedule from the Type dropdown: Select Application or Users & Passwords. Once a type of schedule is chosen from the list, click Save to open the schedule screen of the chosen schedule type.
The tree will be displayed that will mimic the navigation tree, but it will be filtered to show only application types supported for this version of setpoint broadcast. Character Deletion: When the lightning bolt image is displayed and data is deleted from the field by using the standard method of character deletion (backspace key, delete key, control-x, mouse select / cut) the image will not change.
Application Setpoint Group Example: When you have chosen the desired application instance from the Select Application window (Figure 353) and clicked the Save button, the Application Setpoint Group screen for that particular application will open and display the current application information from the controller. Figure 3-57 shows an example of an Application Setpoint Group screen of a Standard Circuit. NOTE: An Application Setpoint Group can be used in as many setpoint broadcasts as desired.
4 Navigation Tree 4.1. Using the Navigation Tree Each level or “node” in the Site Manager Navigation Tree has an icon to illustrate the tree level it belongs to. Each node icon precedes every node description. Application types, application instances, and points are also are represented by icons. Icon Description Directory level Site level The navigation tree is located on the left-hand side of the screen inside the navigation window.
Icon Description Advisory Receiver Commissioning ed, the State/Province/Region drop-down menu will be changed to a blank text field to allow a name to be entered in the field.
The Directory Configuration page opens. A message window will open and ask if you want to delete the directory. Click OK to delete, Cancel to exit. Figure 4-6 - Delete Directory Message Window Figure 4-4 - Directory Configuration Page Enter Name (required field), Parent Directory (if applicable), Active Status, Address, and Country information. Click the Save button to save or the Cancel button to clear and exit the page. 4.2.5.
connecting in the Port field. 4.3. Site A site is the name for a collection of one or more control systems in one physical location such as a grocery store. Under each site, there will be a Control System with listed units such as Einstein or E2. Clicking on the site will open the properties page for the site in the main navigation window. Rightclick for the More Site Tasks menu. 4.3.1.
4.3.3. Edit/Configure Site 4.3.4. Site Properties To make changes to a site, click Edit Site from the desired site’s mouse-over/right-click menu in the navigation tree (under the More Site Tasks fly-out menu).
4.4.1. Control System Properties If Control System Properties is clicked from the navigation tree, the Control System Properties page opens displaying the units, all activities associated with that control system, configurables, and details about the control system. - Results page for the chosen control system and its entities. Firmware can be managed from this section (see Section 5.1., Firmware Package Management). • Details: Connection specifics. 4.4.2.
field. This name will appear in the navigation tree. • Set the Protocol Type to E1 or E2 depending on the type of controller you are using. one system of units. Clicking the unit from the navigation tree will open the unit’s properties page in the main navigation window. • The Connection Type is defaulted to IP. • Enter the IP address of the controller to which you are connecting in the IP Address field. If the Validate IP Address checkbox is enabled (default), only a valid IP address will be accepted.
inside the controller are visible. • Activities: Activities that may be performed on the unit. Link to Terminal Mode is present and unique at this level. • Configuration: Lists all configurables for the unit. • Details: Connection specifics and backup information. 4.5.2. Add Application Instance To add an application instance or multiple application instances, right-click a Unit or an Application Type and choose Add Application.
controller and the navigation tree in Site Manager. Click OK to delete the application instance, Cancel to stop. To open the Edit Application page, right-click the desired application instance from the navigation tree, and select Edit Application Instance.
Each application instance is divided into groups of points. Each group is a tab that contains point names and values. Use your keyboard tab key or use your mouse cursor to move between tabs. • The left column shows the names assigned to points (pre-configured in the controller). Hover the cursor over the names to display its description in the Additional Info panel.
Pointer Configuration If a point is capable of becoming a pointer, the Pointer Configuration icon appears to the right of that point value; click this icon to open the Pointer Configuration pop-up window: Each output point that has the ability to be a pointer can point to multiple other input points within a controller. To connect an output point to multiple input points, click the Pointer Configuration icon of an output. A pop-up window will open and display all the input points connected to that output.
Advisory Configuration An example of how the application type appears inside the main window: Click the Advisory Configuration icon to set up advisory parameters for the current point. This will configure advisories for this point only. Each point that needs advisory configuration will be set up separately. Click OK to apply changes, or Cancel to exit the window without saving. Bypass Configuration If available, click the Bypass Configuration icon to set up the bypass parameters.
An example of how the application instance with points appears inside the main window: The Activity Status page will display the following information: • Target: What activity is in progress. • Date and Time: Date and time the activity actually started. • Activity: The type of activity being performed. • Duration: Elapsed time of the action. • Start Method: On Demand • Requested to Start: The date and time the activity was requested to start by the user. • User: The user who initiated the activity.
4.6.2.1. Terminal Mode Keys (E2 Controller Type Shown) The keys listed in Table 4-3 can be found underneath the terminal mode screens for an E2 and will vary depending on the controller type you are using. Keystrokes are sent directly to the controller, which gives you control right from your desktop as if you were using the keypad on the controller.
Navigation Tree Menu: When the activity has completed successfully, the changes, if any, will be evident automatically on the navigation tree under the selected unit or click on the Refresh button in the navigation frame. Figure 4-35 - Obtain Controller Information Menu Running Obtain Controller Information Activity: Figure 4-37 - Refresh Application Status Screen 4.6.5.
When the activity has completed successfully, the changes, if any, will be evident automatically on the navigation tree under the selected Control System or click on the refresh button in the navigation frame.
If you are at the directory, site, control system, or unit level in the navigation tree, set the filtering with the Filters Rules List (Section 3.2.4.3., Filtering Rules). This allows you to determine how the logs you are retrieving will be filtered. Logs are retrieved directly from the application type, application instance, and logged point levels in the navigation tree.
page previously viewed and the file will be added and selected to the list of available files in the Description File To Upload drop-down list. selected is no longer available. Select one or more unit controllers on the tree that the description file should be sent to. Select the entire directory or entire site if all unit controllers under that directory or site need to be chosen. Select the specific unit controller if you click the right-click menu Upload Description File on the unit level.
The Setpoint Broadcast activity can be run immediately (Run Now) from an application instance level on the navigation tree. Running this activity from an application instance will use the data of that application instance to populate a new Application Setpoint Group. To run Setpoint Broadcast from an application instance, right-click the application instance on the navigation tree and click Create Setpoint Broadcast. Click Save to save the new application setpoint group.
5 Firmware Update 5.1.1. Add Firmware From the Firmware Package Management Configuration page (Figure 5-3), click the Add button to upload a Package to Site Manager. 5.1. Firmware Package Management Before updating the firmware, firmware packages on the Site Manager server can be uploaded and/or deleted from Firmware Package Management at the Control System level on the navigation tree (Figure 5-1) and the Control System Properties page (Figure 5-2).
Select a Package file to upload and click Open to preserve the location and name of the selected file. Clicking Add on the Add Firmware window (Figure 5-6) will retrieve the selected package file, validate the selected file, and add the file to Site Manager. The firmware package file must have.pkg as the extension of the file name.
to select the correct file from the Add Firmware window (Figure 5-9), or click Cancel and return to the Add – Delete Firmware Files (Figure 5-7) window. When you click Delete, a delete confirmation window (Delete Firmware Files) will be displayed (Figure 5-11): Figure 5-11 - Delete Firmware Files Window Figure 5-9 - Firmware Popup Error Window 5.1.2. Delete Firmware The delete firmware package function allows firmware package files to be removed from the Site Manager file system and database.
If there were no errors in the deletion process, you will be returned to the Add – Delete Firmware Files page showing the current list of firmware package files minus the package files that were deleted: A Firmware Update Transfer configuration can be selected from the main navigation tree (Figure 5-14), from a properties page (Figure 5-15), or from the Schedule Manager (Figure 5-16): Figure 5-13 - Add-Delete Firmware Files Page 5.2.
The Firmware Update Transfer configuration is accessed from the Firmware Update Transfer Scheduler (Figure 5-16). The two scheduling options for Firmware Update Transfer are Run Now (Figure 517) and Run On Schedule (Figure 5-18).
the Activity History page when a unit is receiving a package that will be a downgrade to its firmware. Run Firmware Update Transfer On Schedule To run Firmware Update Transfer on schedule: 1. If you choose to Run the Firmware Update Transfer on a schedule (Figure 5-16): Figure 5-22 - Select Yes to Allow Downgrade 5. Select a firmware file to transfer from a list of firmware files (Figure 5-21) that are stored on the Site Manager server. 6.
5.3. Firmware Update Apply Firmware Apply can be configured for execution at the Control System level only from the Schedule Manager (Figure 5-27): Firmware Apply is deployed only from the Control System level on the navigation tree (Figure 525), or the Control System Properties page (Figure 526), or Firmware Apply can be scheduled.
down list (Figure 5-28). The targeted control system on which the firmware apply will take place must be selected using the tree under Configuration (Figure 5-27). The firmware package status, target control system, name, version, last transfer date, language description, language type, and controller type will be displayed for the selected control system if the firmware was transferred from Site Manager only. Any firmware not transferred using Site Manager will not be recognized.
firmware apply. • If the firmware version match is not located, the status of the activity will attempt to determine what version of firmware it does have and report that in the activity status. The activity history will then update to Failed. • If there is a complete match of firmware versions on all the units, the version of the firmware packages on the units will be compared to the firmware package version of the last firmware transfer that is stored in the database. 5.3.3.
6 Advisories Advisories, such as alarms, fails and notices, can be viewed in an advisory view page depending on where the advisory was retrieved. There are two types of advisory view pages: the Live Advisory View and the Historical Advisory View. 6.1. Live Advisory View Acknowledge, Reset, and Clear buttons are disabled until at least one advisory is selected.
plication from where the advisory was generated. • The Select All and Select None buttons allow you to choose all advisories or deselect (clear all) with one click. The number of selected advisories is always displayed under the urgency buttons. Advisories that are selected are highlighted.
6.1.2. Filtering Displayed advisories can be filtered into subsets based on various filtering criteria: Figure 6-7 - Live Advisory View Page Default filtering shows advisories by their Occurrence Date (newest to oldest). This filter can be set to group advisories received Today, Yesterday, the past week (Past 7 Days), month (Last Month), or by custom date range (Custom Range). Filtering by Type groups advisories by Alarm, Fail, or Notice types.
6.2. Historical Advisory View The Historical Advisory View page displays the current advisories (alarms, fails, notices, warnings) from the database in high, medium, and low urgencies. The Historical Advisory View is accessible from any location in the navigation tree from the right-click menu. The advisory alert icon (refer to Section 1.5., Site Manager Interface) appears when a new advisory is received and can be seen from any page in the software.
Customize column settings based on your preference. To customize arrangement, click on each column to set how advisories are sorted or drag and drop. You can also add and show more columns in the table (click the checkbox in the list of available columns) or remove one or more columns (uncheck to remove) and set the width of columns by dragging along the cursor to the desired width. (Settings made to the page will be saved, such that when you leave and return to the page, same page settings apply.
6.2.1. Connection Verification Report This report allows users to determine which sites in the navigation tree are in good communication status and which sites are not (problem sites). The database is searched for this information according to the user-configured settings and a report issued on the database findings. The Connection Verification Report consists of a source path and date, but is initially sorted by date.
sites, and the date and time these sites last had connection. If none exists, a report will still be sent informing the user that no problem site exists. 6.2.2. Purge Inbound Connections Controllers contact Monitoring once a day to verify the connection. In this case, the protocol will dispatch an event that does not include advisories, just connection verification information or records.
6.2.3. Advisory Forwarding Advisories can be forwarded to an e-mail address. Open the Forward Advisories page by clicking on Forward Advisories from any tree level right-click menu, or from the Activities drop-down menu > Activities > Forward Advisories. Description is an optional field for indicating what the advisory forward is for (its purpose). For example, “Notify all west coast supervisors of compressor failures.” Select English or Spanish for Language.
Click the Commission button to send the configurations to the E2 controller, Cancel to stop the commissioning process and exit the screen. Terminal Mode Activity History will show the details of the commissioning process (both the query of the controller for the parameters and the sending of applicable parameters after initializing commissioning). In the E2, press Menu and 7, 3, 5, 4. On the System Tests menu, set Advisory Test to Yes for testing.
7 Configuration To specify a number of weeks or months to keep advisories, click the radio button for “Delete values older than” under the “OR” section and choose the desired setting from the drop-down list. 7.1. Configuring Activities Activities can be configured from individual configuration pages. Choose the property you wish to configure from the navigation tree and right-click to open the menu. Hover cursor over Configure to show all available activity configuration menus.
Click Save to save changes and see the confirmation screen. Click Cancel to exit. To run the Backup, right-click from the navigation tree to access Backup, or click Backup from a properties page. Figure 7-6 - Configure Backup Page Figure 7-4 - Advisory Snooze Configuration Page 7.1.3. Configure Backup The Configure Backup page will display the following information about the activity you are configuring: • Activity: Which activity you are configuring.
rameters for the Log Purge activity. Right-click from any level of the navigation tree, hover over Configure, and click Configure Log Purge. Figure 7-7 - Configure Log Purge Menu The Configure Log Purge page opens: 2 weeks.
Date and Time Recorded Value Same rules apply for compaction by Maximum, except that the highest value is recorded: April 1, 2010 12:45pm 20 April 1, 2010 01:00pm 40 Date and Time April 1, 2010 01:15pm 5 April 1, 2010 12:00pm 20 April 1, 2010 01:30pm 15 April 1, 2010 12:45pm 45 April 1, 2010 01:45pm 35 April 1, 2010 01:30pm 35 April 1, 2010 02:00pm 10 Reduced Value Table 7-4 - Example of Compacting Log Data (Maximum) Table 7-1 - Example of Compacting Log Data Assuming that compactio
Controller Groups Lists depending on where the Power Builder was launched from. Only one type of list may be worked with at a time. Note that Watch Points Lists are used both on the Watch Points page and for Retrieving Logs From List. The Load List drop-down menu displays all the Lists being worked with. Choose the list you wish to work with. If the list is changed with unsaved edits, you will be prompted to save changes. The List Name field contains the list name.
8 Points 8.1. Overview Application points are parameters that have been programmed inside a controller. Access to application points allows the user to view details about controller points, graph points, retrieve logs, and make changes. Points can be viewed in the navigation tree that are both logged and unlogged. Click the Active Points drop-down menu located in the center of the navigation window for point viewing options. Point logs are parameters inside the controller that have been graphed.
Depending on the type of point, the override menu will be available when you right-click: Point Icon Meaning Point Digital Log Database icon indicates a digital point that has logs retrieved in the database. Point System List Log icon indicates a system list point that may have logs in the controller, but not retrieved in the database. Point System List Log Database icon indicates a system list point that has logs retrieved in the database.
rectly from the navigation menu as shown above). The Actions menu on the page will vary depending on the type of point selected. database, advisories will be snoozed. You can set up a default snoozing period at the customer level, site level, or specific advisory level. • Configure Log Purge - takes you to the Configure Log Purge page where you can set parameters for the Log Purge activity. 8.3.
ton to cancel. Click List Power Builder to open the List Power Builder window where you can manage your lists with a variety of Power Builder controls. When all the desired points have been added in the collection, click Display Collection from the Graph Collection menu. A new window will launch and display the graph of the points. Refer to Section 8.4., Display Log Graph for navigation of graphs. Figure 8-11 - Watch Or Graph Point Page Figure 8-13 - Display Collection 8.3.1.
8.4. Display Log Graph Point logs are properties inside the controller that have been graphed. The Display Log Graph screen will open and show a graph view of the data. Save your chosen graph parameters or your custom date range as your default by clicking the Time Range Option button, so that each time you open the Display Log Graph screen, these defaults will apply.
To print the log graph, click the Print icon. Reference information of points will show in the output (information will display next to the legend). Mouse over the value(s) to the right of the graph (for example, Case Temp 1) to see reference information (tree level, controller, application, and point information) about that value. Figure 8-18 - Print Graph Configure the colors and styles of each line in the graph by clicking the Graph Options icon.
9 Graphical Status Screens/Floor Plans NOTE: Convenient, pre-set generic GS Screens are available for viewing controller values and are user-configurable. These GS Screens are included on the navigation tree menu and listed by name. 9.1.1. Generic GS Screens 9.1. Overview A Graphical Status Screen is a customized floor plan that displays refrigeration and environmental control values on a single page with real-time values for multiple entities within the store.
rive at this screen. 9.2. Quick Start Once you have activated this feature, click Add GS Screen from the right-click menu on the Navigation Tree. A blank GS screen opens with the Add Widgets palette. 2. Right-click on the widget for editing capabilities and properties (The Properties menu for widgets will differ depending on what type of widget you are working with. For example, text-based widgets will have more editing options for text formatting). 3. Click on Properties to open the Image Editor. 4.
Run: After a GS Screen has been created and you arrive at a saved GS Screen, you are automatically in Run mode. When in Run mode, right-click to bring up the Actions menu. After creating a GS Screen, toggle the button to Run mode to see the GS Screen operate. If you wish to edit a saved GS Screen, toggle this button to Edit mode so that you can make changes. 9.2.5. JSON Source Code Figure 9-5 shows an example of a view-only JSON Source graphical status screen: 9.2.3.
2. Click Export Zip from the GS Screens drop-down menu. 5. Click Open to open the file or click Save to save the GS screen to a specific location on your computer. Figure 9-6 - Export Zip Menu 3. Name the GS Screen. Enter the name of the GS Screen you wish to export in the Name field and click OK to save. (If you are saving over an existing screen, the name of the screen will show in the Name field. Once you have saved the GS Screen, the save icon will disappear.
Name the GS Screen to save: Figure 9-11 - Name GS Screen to Save Enter a name for the GS Screen and click OK. Once you have saved the GS Screen, the save icon will disappear. The save icon is at the top right of your screen. Publishing/Exporting GS Screens To publish the screen to a location on the Navigation tree, click Export from the drop-down menu. If you choose to Export first, the Save window will pop up to remind you to Save first.
ed Navigation Tree level node. Once a screen has been associated to a specific node on the tree, it will be removed from the list for that node. NOTE: To associate the GS Screen, access the right-click menu on the Navigation Tree and click Associate GS Screen. 9.3.6. Importing GS Screen (.ZIP) Importing a GS screen allows you to view and work with a GS screen (that another user may have sent to you) before it is published in the system for all users to see.
After importing is complete, the new GS screen will be listed on the context menu for that node in the Navigation Tree, (which has been automatically associated for you). down menu will open the GS Screen Properties window and display properties that belong to the GS Screen currently being viewed. To edit the GS screen, click the Run button to move to Edit mode where you can begin working with the floor plan.
locations. • Background Color: Specify a color value to set the background color of the screen, defined like any other CSS color is defined (for example, blue, green, red, or #fabc09 can be entered). • Border: Specify this property to add a border around the GS Screen. For example, entering “5px solid blue” would create a 5-pixel solid blue border (CSS style). • With Auto Scaling enabled, the GS Screen automatically scales up to fit the size of the window.
9.4.1.1. Create GS Screens Quick Start 1. Enable the GS Screens menu by accessing the My Info drop-down menu and selecting User Info. 2. Enable the Show GS Screen Edit Tool checkbox on the My User Info page. Click Save at the bottom of this page. Then click the Refresh button in the navigation tree pane. This enables the Graphical Status Screen Tasks menu when you right-click a node in the navigation tree. 3. Right-click on the desired node in the tree, and choose Add GS Screen.
(use the navigation tree checkboxes to select). The GS Screen will automatically reflect any points that have been previously selected under Point References and carry them over to additional widgets. 9.4.1.5. Visibility GS Screen visibility is set so that unused parts of a graphic will not be visible to the user. For example, if the total number of compressors is 16 and you only need four of them to be seen, the visibility is set so only four are shown on the page.
cation instance of the first reference of the widget being duplicated when first entering this mode (because in most cases the designer would probably want to select the next application instance in sequence after it.) You may continue to edit widgets in any way while in this special mode, and even select other widgets. Once clicking on a node in the tree, all selected widgets will be “rebased” to that node. Group widgets that are selected will also have all their sub-widgets rebased in this way.
see for Specific Properties. For regular graphics, you have the option of adding your own images to the system, or customizing images that are already in the system. Once you save them to the desired destination on your computer, they are then referred to as “user images.” widgets. TIP: Set the Index number for a background image to 0 (zero) and any image that will appear on top of the background image to a number greater than 0 (zero) so the correct stacking order will occur.
“https://” in the URL address. • Link Path: The link path is how to get to the node of the tree you want to go to from where you are now. If the Link Path field is blank, it is assumed that the screen will be loaded at the same Tree node where the current screen has been loaded. This can be done by entering a “relative” path (preferred) or an “absolute” path.
Linking a GS Screen to Other Feature/Function Screens Aside from linking a GS Screen to an external URL or to another GS, a GS Screen can be linked to a feature or function within Site Manager by configuring the Link field from the GS Properties Screen. NOTE: If a user does not have privileges to view or access a feature or a function that is being linked by the widget, the target screen will not load.
To link a widget to a Site Manager feature or function, enter a business action parameter in the Link field under the Common Properties section. Use the input format below: • ${businessAction}: a string constant. Enter this string in the Link field followed by the business action name of the feature or function. be called from and/or applied after saving.) The point reference selected will appear under the Point References section.
Feature/ Function Screens businessActionName Required Link Parameters Edit Site EditSite ${businessAction}EditSite;referenceId=${0.siteID};referenceTreeLevel=1;referenceName=${0.siteName} Add Control System AddControlSystem ${businessAction}AddControlSystem;referenceId=${0.siteID};referenceTreeLevel=1;referenceName=${0.siteName} Edit Control System EditControlSystem ${businessAction}EditControlSystem;referenceId=${0.controlsystemID};referenceTreeLevel=1;referenceName=${0.
Feature/ Function Screens businessActionName Required Link Parameters Obtain Controller Information UnitSynchronize ${businessAction}UnitSynchronize;referenceId=${0.unitID};referenceTreeLevel=3;referenceName=${0.unitName} Refresh Application UnitInventory ${businessAction}UnitInventory;referenceId=${0.unitID};referenceTreeLevel=3;referenceName=${0.unitName} Retrieve Logs Unit Level GetPointLogsUnitLevel ${businessAction}GetPointLogsUnitLevel;referenceId=${0.
from the list (this will not remove the file from the database or tree). Click outside the menu to close and view the file in the tree. • Click Open (Enter) to open the system image in a separate window. • Click Download to save the system image to a location on your drive, or open the image in a separate window. User Images Folder - Right-Click Menu: Uploading Images: To upload an image, click on the browse button (...
Icon Description Function Delete (Delete Key) Deletes user image; click Yes on prompting window to delete image, or No to return to the tree Remove All Erases all filenames from list at once, but will not remove file from the database or tree if it has been uploaded successfully. Click the green check mark to erase the filename from the list (this will not remove the file from the database or tree). Click outside the menu to close and view the file in the tree.
page, it may be disabled by unchecking the Enable System Home Page checkbox in the My Info dropdown menu under User Info. Figure 9-33 - Setting a GS Screen as Your System Home Page 9.4.2.4. Setting a GS Screen as Your Site Home Page Setting a GS Screen as the Site Home Page makes the chosen GS Screen as the landing screen for a given site, control system, unit, application type, or application instance. To set the Site Home Page, while on a GS Screen, click the GS Screens menu and click Properties.
Select the desired widget from the Add Widgets palette and use the right-click menu to edit widget properties. The Add Widgets palette can be moved to anywhere on the screen. Associate the desired points (create point references) to the widgets from the Properties menu. 9.4.3.1. Edit and Run Modes Edit: If you are adding or creating a GS Screen, you are automatically in Edit mode when you first arrive at this page. The Run button indicates that you are in Edit mode.
9.4.4.1. Point Status Information Point status information about a point reference that may change over time (points are continuously refreshed when a screen is being viewed, such as the point value or override status). The format of this replaceable parameter is ${n.xxx} where n is the reference index on the widget and xxx is the parameter being looked up. Note that if the parameter is omitted and only the index is supplied, it will default to the .val parameter as described in Table 9-4.
Parameter Symbol Definition ${0.ovrdStatus} The override status of the point. This will be 0 or 1: 0 - normal 1 - override ${0.responseCode} “Failure” code of the point. Any value other than 0 means there an issue retrieving point status data for this point: 0 - data OK 1 - data none 2 - pt fail 3 - pt inactive 4 - data missing 5 - data na (not available) 6 - notact (not active) 7 - no_val (not ${0.
9.4.4.2. Point Reference Information Information about the point that does not change over time, but is generally fixed over the life of the point. It can be useful when specific information about the point is needed that may not be known until run time. These parameters follow the same format as Point Status Information with a few exceptions. The information is known immediately when the page loads, and does not change over time. The data is also not hookable as it is for Point Status Information.
Parameter Symbol Definition ${0.siteName} The name of the site this point is in. ${0.dirName} The name of the directory this point is in. (lowest level directory only) ${0.type} Interpreted Point Type. This is a way to see the type of point being viewed. The result of this will be one of the following: • String • Analog • Digital • System List Note that a result of ‘String’ basically indicates that the point type is undefined or unknown. Table 9-5 - Point Reference Parameter Information Symbols 9.
Parameter Symbol ${screen.published} Definition The published flag, true if this screen is published (and thus will be seen by all users in the tree when associated) false if unpublished (and thus will only be seen in the tree by the user that created this screen when associated) ${screen.creatorUserId} The database primary key for the user that created this screen. a number. ${screen.author} Textual description of who wrote this screen. This will be the UserBean.first_name and UserBean.
This means that when GsImageCircuitStatus and GsZoneCircuitStatus widget types are newly added, when clicked, they will go to the most obvious place by default (the Standard Circuits graphical status screen for the application on the first point reference on the widget.) Text and Table Widgets For text and table widgets, some of the text features you will see on-screen are listed in the Text Feature column. The options you can enter manually are listed in the Options column.
9.4.4.5. Miscellaneous Parameters A general purpose replaceable parameter. ${br} - Used to insert a line break within the text. 9.4.5. Summary Screen Widget Figure 9-41 - Saving the Sub-Screen The Summary Screen widget GsAppSummaryTable will be available on the GS Screen at the control system, unit, and application type levels on the tree. It will not appear on the widget menu for screens at directory, site, and application instance levels. 1.
3. Right-click and select properties on the widget to view and edit the properties of the widget: sponding application types found for the specified application type where the GS screen is located. This can span multiple units if the GS screen is at control system level. • If there are no applications found for the specified application type, no rows will be shown in the widget. • The widget may be resized by selecting the widget and dragging the corners to make it smaller or larger.
ure 9-48). LOSS columns: • A list of all common application types will be listed. • If the application type is not selected, a warning message will appear as a reminder that an application type must be selected. • If the GS screen was created at the application type level, Application Type will be pre-filled.
10 Revision History This chapter contains important supplementary information related to the latest specified release that may not appear in the main product documentation. We recommend that you read this chapter in its entirety. The notes cover one release, and the features are cumulative. • Setpoint Broadcast enhancements to provide for a more generic functionality. This includes the ability to broadcast user applications.
Index A Activation, Feature 10 Activity History 15 column headings 15 Add Application Instance 44 Add Widgets Palette 93 Admin Activity History 24 view results of 24 Administrator Menus 17 setup of 17 Advisories 65 configuring purge 74 filtering 67 historical advisory view 68 live advisory view 65 Advisories Alert Icon 6 Advisory Configuration 48 Advisory Forwarding 72 Advisory Receiver Commission 43, 72 Advisory Snooze, configuration of 74 Application Instance Properties 48 Application Setpoint Group 33, 3
deployment of 62 downgrades and setpoint clean-out 64 firmware matching 64 firmware matching and activity history role 63 non-gateway controllers first, gateway last 64 successful or failed results 64 Firmware Package Management 56 adding 56 deleting 58 Firmware Transfer 59 downgrading 61 interruptions 61 run now 60 run on schedule 61 scheduling 60 Firmware Update 56 Apply 62 Firmware Package Management 56 Transfer 59 Forward Advisories 72, 81 G Graph Collection 82 Graphical Status Screens/Floor Plans (see
Log Purge, configuration of 75 Login 3 forgot ID 4 forgot password 4 Logout 4 M Maintenance Upgrades & Tech Support Licensing 11 Menus 14 Admin Tools 17 My Info 14 mware 63 My Pending Activities 15 My User Info 14 Protocol Access Levels drop-down list of 20 Purge Inbound Connections 71 Purging advisories 74 inbound connections 71 logs 75 R Refresh Application 51 Refresh Point List 51 Refresh Units 52 Registration, Software 8 Restore 52 Retrieve Logs 52 N Navigation Tree 5, 37 levels 37 menus and icons 3
T Target Controller Group 34 Terminal Mode function keys 50 initializing 49 Troubleshooting 13 U Units 43 properties 43 Upload Description File 53 Urgency Bucket 69 User Manager 17 adding new 18 configuring information 18 deleting 19 editing 18 page illustration of 17 User Menus Activity History 15 My Pending Activities 15 User Info 14 enabling system homepage 14 Hide Nav Frame checkbox 15 setting the engineering units 14 Show GS Screen Edit Tool checkbox 14 W Widget Parameters 105 Widget Screen Linking 9
The contents of this publication are presented for informational purposes only and they are not to be construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. Emerson Retail Services, Inc. reserves the right to modify the designs or specifications of such products at any time without notice. Emerson Retail Services, Inc. does not assume responsibility for the selection, use or maintenance of any product.
