Table of Contents

Advertisement

Quick Links

026-1012 Rev 3 06-DEC-2011
Site Manager User Manual

Advertisement

Table of Contents
loading

Summary of Contents for Emerson Site Manager

  • Page 1 026-1012 Rev 3 06-DEC-2011 Site Manager User Manual...
  • Page 3 Retail Solutions 3240 Town Point Drive NW Suite 100 Kennesaw, GA 30144 Phone: 770-425-2724 Fax: 770-425-9319...
  • Page 5: Table Of Contents

    1.2.1.1. Tips for Narrowing Your Search Criteria ........................... 2 1.3. Q ................................3 UICK TART 1.3.1. Overview ................................3 1.3.2. Supported Browsers .............................. 3 1.3.3. Launching Site Manager ............................3 1.4. L ................................3 OGIN OGOUT 1.4.1. Login ..................................3 1.4.2. Logout ................................... 4 1.5.
  • Page 6 4.6.8. Retrieve Logs............................... 52 4.6.9. Upload Description File............................53 4.6.9.1. Description File Upload to the E2 Controller ........................54 4.6.10. Create Setpoint Broadcast ..........................54 5 FIRMWARE UPDATE ............................... 56 vi • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 7 5.1. F ......................... 56 IRMWARE ACKAGE ANAGEMENT 5.1.1. Add Firmware ..............................56 5.1.2. Delete Firmware ..............................58 5.2. F ..........................59 IRMWARE PDATE RANSFER 5.2.1. Downgrading Firmware ............................. 61 5.2.2. Firmware Update Transfer Interruption......................61 5.3. F ............................62 IRMWARE PDATE PPLY 5.3.1.
  • Page 8 9.4.4.5. Miscellaneous Parameters............................... 112 9.4.5. Summary Screen Widget............................ 112 9.4.5.1. Widget Behavior ................................113 9.4.5.2. Properties Menu ................................113 9.4.5.3. Points, Headers, Values ..............................114 10 REVISION HISTORY............................. 115 INDEX ................................... 117 viii • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 9: Overview

    1.2. Basic Concepts Directory To search for a directory, the following criteria Using the Site Manager user interface, you can log can be entered: Name of directory, city, state code, in, log out, backup and restore sites, add, edit, delete, state name, country code, country name.
  • Page 10: Tips For Narrowing Your Search Criteria

    To search for help, the following criteria can be display name limits searches to display name of en- entered: Help contents. tities unittype limits searches to unit types Table 1-1 - Allowed Prefixes to Narrow Down Search Criteria 2 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 11: Quick Start

    1.3. Quick Start 1.3.1. Overview In this section you will find step-by-step instruc- tions on how to log in to Site Manager, set up the nav- igation tree, user access, and communication information. From the navigation tree you can con-...
  • Page 12: Logout

    3. The changed password will be sent to the e-mail ad- dress associated with your login ID. 4. Site Manager will show an information (Figure 1- 3) to let you know that an e-mail was sent contain- ing new password information and redirects you to the Login screen after 5 seconds.
  • Page 13: Site Manager Interface

    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.
  • Page 14: Navigation Tree

    Users can see the alert icon from anywhere in Site Manager. Click on the alert icon to go to the Historical Advisory View page and see the advisory history.
  • Page 15: Menu Bar

    • To access the online help system, click Help for the drop-down menu. 1.5.4. Main Window The main window of the Site Manager is located to the right of the Navigation frame and takes up most of the space on the screen. Mouse over the name of the menu you would like to select and the drop-down menu will appear.
  • Page 16: It Administrator Functions

    Functions 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 de- sired feature.
  • Page 17 Figure 2-5 - Product Activation License Registration Information Page Your information will automatically be sent to Emerson Retail Solutions. If successful, a confirma- tion window (Figure 2-6) will open to notify you that your registration information has been sent. Figure 2-7 - Product Activation License Registration Page (for...
  • Page 18: Activation

    • Step 2 - Enter SolutionsLicensing@emer- son.com in your e-mail's To: field. • Step 3 - In the Subject: field of your e-mail, en- ter Site Manager Product Activation License SO# (followed by the Sales Order number ob- tained from customer service).
  • Page 19: Licensing

    Support Licensing visible with certain user privileges enabled to allow you to add/edit software license keys. The basic features of Site Manager require a Main- tenance Upgrades & Tech Support license key. Only Locate your unique Hardware Fingerprint num- new users will need to enter this key. As the one-year ber on the Feature Licensing page.
  • Page 20: About Feature Licensing And Keys

    Note schedules be backed up. that for the Site Manager PC application, all sites to be 1. Back up the database using the standard procedure imported are assumed to be E2 sites and must be for your particular database.
  • Page 21: Default Time Zone During Import

    XML file. (The XML import tool can be run as many times as desired and If Site Manager encounters a program malfunction will only import new sites and directories. To run it during a user’s browsing session, an error report will...
  • Page 22: Menus

    (figure on the left). NOTE: If the user has Pending Activities with a status that needs to be viewed, this page will be the first page in the Site Manager main win- dow that the user sees upon entering Site Man- ager.
  • Page 23: My Pending Activities

    • User - the user who started the activity. Activities page will be the first page the user sees when first logging into Site Manager. • Target - the node from where the activity was start- ed. (Clicking a link in the Target column will open 3.1.4.
  • Page 24 Spreadsheet, HTML, and PDF. Select the format from the Export drop-down and select whether to ex- port All activities displayed or only those Not Com- pleted (“Failed” and “Partially Completed” activities). 16 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 25: Admin Tools Menu

    3.2.1. Setup 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. Figure 3-8 shows the menu when expanded: Figure 3-8 - Admin Tools Menu (Expanded view shown)
  • Page 26 Metric Units button to set all fields to Metric. Click Save to store the settings and exit the screen or Cancel to cancel changes and exit the screen. 18 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 27: Group Manager

    Deleting a User Click the Group Name header for a quick sort or click the drop-down arrow to open the sort menu: Delete a user by selecting the username (Adminis- trator excluded) and clicking Delete. A confirmation window will open asking if you are sure you want to delete the user.
  • Page 28 Under the Op- tional section: If this protocol checkbox is enabled here (at the control system level), Site Manager will use the protocol information entered at the control system level and bypass the information at the group level for only the units located under this control sys- tem.
  • Page 29: Directory Manager

    Click Save to save the new Group and its privileg- Click the Directory header for a quick sort or click es and go back to the Group Manager page. Click the drop-down arrow to open the sort menu: Cancel to exit without saving and go back to the Group Manager page.
  • Page 30: Site Manager

    The Site Manager lists all sites in the database. Configuration page. Edit the directory information by From the Site Manager page you can select a site to changing the current information in the fields, or by edit, delete a site, view its properties, or jump to the entering new information for a new directory in the Site Configuration page to add a site.
  • Page 31: Contractor Manager

    Click Save to store changes or Cancel to exit This will take you to the Contractor Properties page without saving and return to the Site Manager page. that will show details about the selected contractor. Figure 3-26 - Contractor Manager Page...
  • Page 32: Pending Activities

    NOTE: If the user has pending activities with a status that needs to be viewed, the Pending Activities page will be the first page the user sees when first logging into Site Manager. 3.2.3. Admin Activity History 3.2.3.1. View History...
  • Page 33 Activity History - Results at the administrator lev- view by Result type. el shows a complete history of activities performed, • Exceptions Report - Click the Exceptions Report including such information as the type of activity that icon from this column to open a window that dis- was performed, start and finish times, duration of the plays details of the activity that was either failed or activity, user information, and more.
  • Page 34: Configure Purge

    • Name: A unique descriptive name given to a sched- ule by the user or Site Manager in case of a system scheduled activity. • Type: The type of activity scheduled. If it is a sys- tem scheduled activity, then the Type will be sys- tem.
  • Page 35 used in Activity History. The graphic below shows an example of a Backup The status may be clicked on to view the detailed ac- activity to be scheduled on a daily basis (Calendar tivity history for that schedule. Based): The status will be linked to the most recent activity history that is attached to the schedule and has not been purged.
  • Page 36: User Schedules

    (Run On Schedule). Or select the All button instead of manually clicking on each option at the end of each selection. Clear any selections by clicking on the Clear but- ton. 28 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 37 Click the Power Builder link to open the List For scheduling Refresh Point List, enter a name Power Builder window. 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).
  • Page 38: Filtering Rules

    Filtering Rules is a configuration of the Retrieve Logs, Retrieve Logs From List, Setpoint Broadcast, Figure 3-44 - Scheduling Firmware Transfer Refresh Point List, and Backup activities. Use the Fil- 30 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 39: Send Email

    3.2.5. Send Email 3.3. Activities Menu This page allows you to create and send emails to users of Site Manager. To go to this page, click the Admin Tools menu, then click Send Email. The 3.3.1. Advisory Menus Send Email page opens (Figure 3-47).
  • Page 40: Advisory Forwarding

    • On Success: Activity was successful. • On Unsuccessful: Activity was unsuccessful, which means partially completed or failed. Figure 3-48 - Configuring Setpoint Broadcast Figure 3-49 - Notify Setpoint Broadcast 32 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 41 If either option is selected, the notification can be next to the Test Send checkbox will notify the users configured. Two notification options are available: that selecting the checkbox will not actually send the values. • Pop-up: A popup message will open if you are logged into the system at the time the message is sent out.
  • Page 42 (see Section 7.2.1., List Power Builder). Give the group a unique name. (You will be prompted if the name entered matches a target group already in the database.) 34 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 43: Schedules Setup

    The tree will be displayed that will mimic the nav- Character Deletion: When the lightning bolt im- igation tree, but it will be filtered to show only appli- age is displayed and data is deleted from the field by cation types supported for this version of setpoint using the standard method of character deletion broadcast.
  • Page 44 Cancel to cancel your changes and navigate away from the screen. When saved, the new application setpoint group will add in the list of current application setpoint groups. 36 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 45: Navigation Tree

    Navigation Tree Each level or “node” in the Site Manager Naviga- tion Tree has an icon to illustrate the tree level it be- longs to. Each node icon precedes every node description. Application types, application instances, and points are also are represented by icons.
  • Page 46: Directory

    To add a directory, right-click the Site Manager the directory. It holds a list of multiple sites and/or di- root menu at the top of the tree and click Add Direc- rectories.
  • Page 47: Directory Properties

    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 4.2.5. Edit/Configure Directory Enter Name (required field), Parent Directory (if To make changes to a directory, click the Edit Di- applicable), Active Status, Address, and Country...
  • Page 48: Site

    Optional section: If this protocol checkbox is en- control systems in one physical location such as a gro- abled at the control system level, Site Manager will cery store. Under each site, there will be a Control use the protocol information entered on this page and System with listed units such as Einstein or E2.
  • Page 49: Edit/Configure Site

    4.3.3. Edit/Configure Site 4.3.4. Site Properties To make changes to a site, click Edit Site from the If Site Properties is clicked from the navigation desired site’s mouse-over/right-click menu in the nav- tree, (under the More Site Tasks flyout menu) the igation tree (under the More Site Tasks fly-out Site Properties page opens displaying the active con- menu).
  • Page 50: Control System Properties

    Units of that control system type such as Rack mouse-over/right-click menu in the navigation tree. A or HVAC. (Site Manager will allow a tree with The Control System Configuration page opens: more than one control system of the same type in each site).
  • Page 51: Advisory Receiver Commission

    Optional section: If this protocol checkbox is en- abled at the control system level, Site Manager will use the protocol information entered on this page and bypass the information at the Group level for only the units located under this control system.
  • Page 52: Add Application Instance

    • Application Name - Assign a name for the applica- tion you wish to add (max of 15 characters). If the name assigned to the application is already in use, a 44 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 53: Edit Application Instance

    Site Manager. To open the Edit Application page, right-click the Click OK to delete the application instance, Cancel desired application instance from the navigation tree, to stop. and select Edit Application Instance. Figure 4-21 - Delete Application Instance Menu...
  • Page 54 (as set by the (When Full Options is displayed, the Reduced Op- controller). tions mode is in use, and vice versa.) Full Options al- 46 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 55: Log Configuration

    Pointer Configuration Each output point that has the ability to be a point- er can point to multiple other input points within a If a point is capable of becoming a pointer, the controller. To connect an output point to multiple in- Pointer Configuration icon appears to the right of put points, click the Pointer Configuration icon of an...
  • Page 56: Application Type Properties

    An example of how an application type appears on pears on the navigation menu: the navigation menu: Figure 4-31 - Application Instance Properties - Navigation Tree Menu Figure 4-29 - Application Type Properties - Navigation Tree Menu 48 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 57: Executing Activities

    An example of how the application instance with The Activity Status page will display the following points appears inside the main window: information: • Target: What activity is in progress. • Date and Time: Date and time the activity actually started.
  • Page 58: Terminal Mode Keys (E2 Controller Type Shown)

    Obtain Controller Information will need to be run screen screen screen (or equivalent operation) for Site Manager to display the current information in the controller and synchro- Table 4-3 - Front Panel Function Keys For an E2 nize the updates from the controller configuration and the GS Screen.
  • Page 59: Refresh Application

    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.
  • Page 60: Refresh Units

    • By Application Type - Retrieves points with logs from the selected application type. • By List - Retrieves only the points with logs from a previously made list. 52 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 61: Upload Description File

    Open to upload the selected file to You can also retrieve logs from the Watch Or the Site Manager server. Only *.dsc files will be up- Graph Log Points page. loaded. If the file name does not contain the .dsc ex- tension, a popup error window will be displayed 4.6.9.
  • Page 62: Description File Upload To The E2 Controller

    Site Manager Server, then the drop-down list de- faults on Select Description File. A popup message will appear that states The Description file previously 54 •...
  • Page 63 The Setpoint Broadcast activity can be run imme- Click Save to save the new application setpoint diately (Run Now) from an application instance level group. The new application setpoint group will add to on the navigation tree. Running this activity from an the list of current application setpoint groups under application instance will use the data of that applica- the Application Setpoint Group section.
  • Page 64: Firmware Update

    5.1. Firmware Package Management Before updating the firmware, firmware packages on the Site Manager server can be uploaded and/or de- leted 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).
  • Page 65 5-6) will retrieve the selected package file, vali- date the selected file, and add the file to Site Manager. The firmware package file must have.pkg as the ex- tension of the file name.
  • Page 66: Delete Firmware

    Figure 5-10 - Selecting Firmware Files to Delete from Add- to the Add - Delete Firmware Files window (Figure Delete Firmware Files Window 5-10). The package will be deleted. Firmware versions cannot be deleted. 58 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 67: Firmware Update Transfer

    If there were no errors in the deletion process, you A Firmware Update Transfer configuration can be will be returned to the Add – Delete Firmware Files selected from the main navigation tree (Figure 5-14), page showing the current list of firmware package from a properties page (Figure 5-15), or from the files minus the package files that were deleted: Schedule Manager (Figure 5-16):...
  • Page 68 • Run on Schedule (schedule the activity to deploy at not occur. As a precaution, a warning will appear in a specified date and time) 60 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 69: Downgrading Firmware

    Run Firmware Update Transfer On Schedule the Activity History page when a unit is receiving a package that will be a downgrade to its firmware. To run Firmware Update Transfer on schedule: 1. If you choose to Run the Firmware Update Transfer on a schedule (Figure 5-16): 2.
  • Page 70: Firmware Update Apply

    Firmware Apply deployment may be accessed from the main navigation tree at the control system level (Figure 5-27) or from the Schedule Manager by selecting the Firmware Apply activity from the drop- 62 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 71: Firmware Matching And Activity History Role

    Site Manager only. Any ware. If any unit fails the battery test, the Firmware firmware not transferred using Site Manager will not Apply will automatically be cancelled, and the Activ- be recognized.
  • Page 72: Downgrades And Setpoint Clean-Out

    The activity history will also be updated with 64 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 73: Advisories

    Advisories Acknowledge, Reset, and Clear buttons are dis- abled until at least one advisory is selected. Advisory retrieval should normally take 10 sec- Advisories, such as alarms, fails and notices, can onds per unit, but could take longer for first-time re- be viewed in an advisory view page depending on trieval;...
  • Page 74 • The type of advisory (alarm, notice, failure) • The advisory’s priority setting • The advisory’s current status • Whether the advisory was returned-to-normal • The parent controller where the advisory originated 66 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 75: Filtering

    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).
  • Page 76: Historical Advisory View

    Site Manager Interface) appears when a new adviso- 6.2. Historical Advisory ry is received and can be seen from any page in the software. Clicking on the alert icon will open this View page so the advisory can be viewed. Once the adviso- ry has been viewed the alert icon will turn off until an- other advisory is received.
  • Page 77 Customize column settings based on your prefer- ence. To customize arrangement, click on each col- NOTE: When you click an advisory at the Unit umn to set how advisories are sorted or drag and drop. level, a terminal mode window will automati- cally pop up for that unit.
  • Page 78: Connection Verification Report

    A system schedule can be configured to run and send a report (via email) listing the problem sites that occurred over a set period of time. Problem sites are 70 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 79: Purge Inbound Connections

    sites, and the date and time these sites last had connec- tion. 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 ver- ify the connection.
  • Page 80: Advisory Forwarding

    Monitoring. This mail by activating the Fail, Alarm, or Notice check- will be set automatically by Site Manager if there is boxes. If advisories that have been returned to normal no unique ID in the system.
  • Page 81: Terminal Mode

    Terminal Mode Click the Commission button to send the configu- rations to the E2 controller, Cancel to stop the com- From the unit level on the navigation tree, launch missioning process and exit the screen. the Terminal Mode viewer and log in to the E2. Activity History will show the details of the com- In the E2, press Menu and 7, 3, 5, 4.
  • Page 82: Configuration

    The default value for hours and minutes is 74 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 83: Configure Backup

    Click Save to save changes and see the confirma- To run the Backup, right-click from the navigation tion screen. Click Cancel to exit. tree to access Backup, or click Backup from a prop- erties page. Figure 7-6 - Configure Backup Page Figure 7-4 - Advisory Snooze Configuration Page The Configure Backup page will display the fol- lowing information about the activity you are config-...
  • Page 84 (choices are from 1-156). For example, if 2 is selected, the system will only store logs that are 2 Table 7-1 - Example of Compacting Log Data weeks old or less and purge logs that are older than 76 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 85: Configuration Tools

    The List Power Builder window can be launched be grouped together and compressed by Average. from 3 different places in Site Manager: The Watch That is: (10 + 20 + 10 + 20) / 4 = 15. Points screen, Schedule Manager page when schedul- 2.
  • Page 86: Bulk Site Name Report

    Additionally, Point Category and its corre- reminder window will give you the option to save. sponding Active-Log setting may be used as part of the matching criteria by specifying a value in these 78 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 87: Points

    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.
  • Page 88: Point Properties

    Point Digital Log icon indicates a digital point that may have logs in the controller, but not retrieved in the database. Table 8-1 - Examples of Logged Point Icon Types 80 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 89: Watch Or Graph Log Points

    rectly from the navigation menu as shown above). database, advisories will be snoozed. You can set up a default snoozing period at the customer level, site The Actions menu on the page will vary depending on level, or specific advisory level. the type of point selected.
  • Page 90: Graph Log Points While Viewing A Gs Screen

    To display the graph of the point, run the Retrieve Logs activity first and run another Display Log Graph. Figure 8-12 - Graph Collection Menu 82 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 91: Display Log Graph

    Save your chosen graph parameters or your cus- 8.4. Display Log Graph tom date range as your default by clicking the Time Range Option button, so that each time you open Point logs are properties inside the controller that the Display Log Graph screen, these defaults will ap- have been graphed.
  • Page 92 (as shown in Figure been logged. 8-21). Click the Excel icon to export log data to an Excel spreadsheet (.xls format) then Save or Open to ac- cess. 84 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 93: Graphical Status Screens/Floor Plans

    When a GS screen is published, GS screens can be kept private or published to the all Site Manager users will be able to view it. The con- Navigation Tree for other users to access. When a GS...
  • Page 94: Quick Start

    GS screens only.) 1. Click the desired widget(s) from the Add Widgets palette and it will appear on the blank GS Screen. You are automatically in Edit mode when you ar- 86 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 95: Widgets And Images

    GS screen schema, and the level in the tree the screen was created in. The .ZIP version has to be less than or equal to the Site Manager version and GS schema installed on the customer server in order Figure 9-4 - Setting a GS Screen as Your Home Page for the screen to be imported.
  • Page 96: Saving The Gs

    Figure 9-8 - Saving GS Screen Figure 9-10 - GS Screens Save Menu 88 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 97: Delete The Gs

    ed, a confirmation message will appear to let you know that the GS Screen has been deleted from the Name the GS Screen to save: system. Figure 9-11 - Name GS Screen to Save Figure 9-13 - GS Screen Confirmation Message Window Enter a name for the GS Screen and click OK.
  • Page 98: Disassociate The Gs Screen

    Figure 9-18 - Importing GS Screen NOTE: The .ZIP file(s) must match the level (or “node”) of the tree and the Site Manager software version it was created from in order to Figure 9-16 - GS Screen Disassociate Menu successfully import.
  • Page 99: Import Results

    After importing is complete, the new GS screen down menu will open the GS Screen Properties win- will be listed on the context menu for that node in the dow and display properties that belong to the GS Navigation Tree, (which has been automatically asso- Screen currently being viewed.
  • Page 100: Widgets And Creating Gs Screens

    • Read-only field that shows the date/time the GS Screen was created or last imported. • Read-only field that shows the current Site Manager software version. • GS Screen Schema indicates the version number of the GS Schema. This number changes whenever structural changes to the screen design changes.
  • Page 101: Create Gs Screens Quick Start

    You can also install your own widgets by working with. For example, text-based widgets will loading them into the Site Manager server file system have different options for text formatting than table- and create your own directories to store your widgets.
  • Page 102: Visibility

    The tree will automatically synchronize to the appli- 94 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 103: More Widget Editing

    cation instance of the first reference of the widget (flush) with each other being duplicated when first entering this mode (be- • Horiz. Center: centers the widgets equally hor- cause in most cases the designer would probably izontal depending on the starting position of the want to select the next application instance in se- widgets.
  • Page 104: Common Properties

    URL address can also be entered into this field. When in Run mode, click that widget to go to • Z-Index: Reflects the stacking order of positioned the link you entered. Be sure to include “http://” or 96 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 105: Widget Screen Linking

    “https://” in the URL address. screen to show as part of the graph. For exam- ple, ${graph,1,2}GraphSubScreen would • Link Path: The link path is how to get to the node pop up the log graph for the points specified by of the tree you want to go to from where you are references 1 and 2, and also load the GS Screen now.
  • Page 106 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 configur- ing the Link field from the GS Properties Screen. NOTE: If a user does not have privileges to...
  • Page 107 To link a widget to a Site Manager feature or func- be called from and/or applied after saving.) The point tion, enter a business action parameter in the Link reference selected will appear under the Point Refer- field under the Common Properties section. Use the ences section.
  • Page 108 Information enceName=${0.csName} ${businessAction}ControlSystemInventory;referen- Refresh Units ControlSystemInventory ceId=${0.controlsystemID};referenceTreeLevel=2;refer- enceName=${0.csName} ${businessAction}GetPointLogsCSLevel;referen- Retrieve Logs GetPointLogsCSLevel ceId=${0.controlsystemID};referenceTreeLevel=2;refer- CS Level enceName=${0.csName} ${businessAction}BackupUnitActivity;referen- Backup Unit BackupUnitActivity ceId=${0.unitID};referenceTreeLevel=3;reference- Name=${0.unitName} Table 9-2 - Business Action Screen Links 100 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 109: Image Library

    Feature/ businessActionName Required Link Parameters Function Screens ${businessAction}UnitSynchronize;referen- Obtain Controller UnitSynchronize ceId=${0.unitID};referenceTreeLevel=3;reference- Information Name=${0.unitName} ${businessAction}UnitInventory;referenceId=${0.unit- Refresh Application UnitInventory ID};referenceTreeLevel=3;referenceName=${0.unit- Name} ${businessAction}GetPointLogsUnitLevel;referen- Retrieve Logs GetPointLogsUnitLevel ceId=${0.unitID};referenceTreeLevel=3;reference- Unit Level Name=${0.unitName} ${businessAction}InitialTerminalMode;referen- Terminal Mode InitialTerminalMode ceId=${0.unitID};referenceTreeLevel=3;reference- Name=${0.unitName} Table 9-2 - Business Action Screen Links 9.4.1.11.Image Library own directories to store the user images you create.
  • Page 110 (this will not remove the file from the da- cur. tabase or tree if the files have uploaded successful- ly). Table 9-3 - Image Library Menu Icons and Tools • Click the green checkmark to erase the filename 102 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 111: Running Gs Screens

    For Site Manager to display the current informa- Icon Description Function tion in the controller and synchronize the updates Delete Deletes user image; from the controller configuration and the GS Screen, click Yes on prompt- (Delete Key) an Obtain Controller Information or equivalent activ-...
  • Page 112: Setting A Gs Screen As Your Site Home Page

    Home Page checkbox then click Save. ed, all other screen elements will be excluded. 9.4.2.7. Logout Button Click Logout button to log out of Site Manager and be returned to the Login page. 9.4.3. Widget Editor When Add GS Screen is clicked from the naviga-...
  • Page 113: Edit And Run Modes

    For example, to display the temperature of point reference 0 within a Text widget, one might use the la- Select the desired widget from the Add Widgets bel text of %{ label.temp}: ${0} ${0.engUnits}. In palette and use the right-click menu to edit widget which case the actual output in the widget would look properties.
  • Page 114: Point Status Information

    If the point is in override, 0 indicates the point is in a FIXED override and 1 indicates that it is in a TIMED override Table 9-4 - Point Status Information Parameter Symbols 106 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 115 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...
  • Page 116: Point Reference Information

    The name of the application this point is in. ${0.unittName} The name of the unit this point is in. ${0.csName} The name of the control system this point is in. Table 9-5 - Point Reference Parameter Information Symbols 108 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 117: Locale Resource Message Keys

    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: •...
  • Page 118 Figure 9-36 - GsImageCircuitStatus and GsZoneCircuitStatus Menu from the Add Widget Palette The GsImageCircuitStatus and GsZoneCircuit- Status widgets have a default Link of Standard Cir- cuits Graphical Status and a default Link Path of ${0.appInstPath}. 110 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 119 This means that when GsImageCircuitStatus and Choose images to build GS Screens from the Im- age Library by clicking the browse icon (...) and GsZoneCircuitStatus widget types are newly added, choosing from the directories. You can also create when clicked, they will go to the most obvious place your own directories.
  • Page 120: Miscellaneous Parameters

    Figure 9-46 - Adding Widget to GS Screen Points to be associated with this widget can be pre- selected before selecting the widget, similar to the be- havior of the other widgets. Figure 9-44 - Rename Image 112 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 121: Widget Behavior

    3. Right-click and select properties on the widget to sponding application types found for the specified view and edit the properties of the widget: application type where the GS screen is located. This can span multiple units if the GS screen is at control system level.
  • Page 122: Points, Headers, Values

    • From the application summary widget, you can left- ing image under OAT OUT and REFR PHASE click on a specific row and Site Manager will auto- matically bring up the specific application GS screen for the application instance (for example, the RTU graphical status screen).
  • Page 123: Revision History

    10 Revision History This chapter contains important supplementary in- formation related to the latest specified release that may not appear in the main product documentation. We recommend that you read this chapter in its entire- ty. The notes cover one release, and the features are cumulative.
  • Page 125: Index

    Index 23, 40 adding new configuring information Control System Configuration page illustration of deleting editing Activation, Feature properties Activity History Create Setpoint Broadcast column headings Add Application Instance Add Widgets Palette Delete Application Instance Admin Activity History Directories view results of 21, 38 adding new Administrator Menus...
  • Page 126 Maintenance Upgrades & Tech Support disassociating List Power Builder exporting .ZIP Bulk Site Name Report importing .ZIP Live Advisory View properties navigation publishing Locale Resource Message Keys saving Log Configuration 118 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 127 Setpoint Broadcast Point References create Point Status Information 14, 18 Show GS Screen Edit Tool Checkbox parameter format Site Home Page parameter symbols Site Manager Pointer Configuration launching software Points Sites actions 22, 38 adding new configuring advisory snooze 22, 41...
  • Page 128 Hide Nav Frame checkbox setting the engineering units Show GS Screen Edit Tool checkbox Widget Parameters Widget Screen Linking Widgets context menu/properties texts XML datafile importing of 120 • Site Manager User Manual 026-1012 Rev 3 06-DEC-2011...
  • Page 130 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.

Table of Contents