Versions Compared

Version Old Version 1 New Version 2
Changes made by

Documentation Reviewer

Documentation Reviewer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • [Installing the Connect user interface User Interface (UI)
  • [Working with usersUsers
  • [Working with rolesRoles
  • [Creating an agentAgent
  • [Licensing the mini agentMini Agent
  • [Simple connect mini agent deploymentConnect Mini Agent Deployment
  • [Assigning a static Static IP address to mini agentAddress to a Mini Agent
  • [Obtaining IP information Information from a BAS networkNetwork

Anchor
files_installing_the_connect_use_6743
files_installing_the_connect_use_6743
Anchor
_Toc517869437
_Toc517869437
Installing the Connect

...

User Interface (UI)

The following steps will facilitate installation of the Connect UI.

Image Modified

Download the Installing and Licensing the UI_User training guide.

  1. To install the Connect UI, go to the following link - Connect 2018_Setup.
  2. A message displays asking, "What do you want to do with connect2018_setup.exe?" You can save the file to your computer and then double-click to run the file or choose Run to start the installation.
  3. In the Welcome window, choose Install.



  4. This will complete the Connect installation. Choose Finish.



  5. Launch Connect by double-clicking the Connect 2018 icon on the desktop.
  6. The Connect login window displays.A license must be requested via an existing user with licensing authority. An email will be sent to the new user's email address containing a temporary password. The new user may then change the provided password.    

    Image Modified
  7. Open Connect after receiving the email.
  8. Enter username and temporary password.

    Image Modified

Anchor
_Toc517869438
_Toc517869438
Working with users

Anchor
files_working_with_users_htm
files_working_with_users_htm
Image Modified

Download the Users training guide.

Anchor
files_working_with_users_htm_cre_6817
files_working_with_users_htm_cre_6817
Anchor
_Toc517869439
_Toc517869439
Creating a user

To create a new user

  1. Choose the drop-down arrow to the far right of the menu bar.

    Image Modified
  2. Choose Edit Users/Roles.

    Image Modified
  3. In the Users and Roles window, in the Users tab, choose Add.

    Image Modified
  4. Enter the Email Address of the user you are creating. 
    Note:

...

  1.  Each user must have a unique email address.
  2. Choose OK.
  3. In the Create User window, choose Yes.

    Image Modified
  4. In the Edit User window, enter the Name and choose the Role for the user. 

...

  1. Note:

...

  1.  The Admin User role is the only installed role. For information on about roles, see [Working with roles.

    Image Added
  2. Choose OK.
  3. After the user is created, a success window displays. Choose OK.
    Image Modified
  4. The user needs to check their email inbox for an email containing their temporary password.

Anchor
files_working_with_users_htm_new_708
files_working_with_users_htm_new_708
Anchor
_Toc517869440
_Toc517869440
New user login and password change

The assumption is that the new user has installed Connect.

...

  1. Choose OK.
  2. Choose OK in the Success window.

Anchor
files_working_with_users_htm_for_4277
files_working_with_users_htm_for_4277
Anchor
_Toc517869441
_Toc517869441
Forgot password

  1. In the Login window, choose Forgot Password.

...

  1. Follow the steps in [New_user_login_and_password_change.

Anchor
_Toc517869442
_Toc517869442
Working with roles

Anchor
files_working_with_roles_htm
files_working_with_roles_htm
A role defines a set of permissions for actions and/or objects available for users within Connect and may be applied to objects as well. A role may be assigned to multiple users and multiple objects, however a user can have only one role assigned. See [Creating_a_user for information about assigning a role to a user. For more information about object roles application, see [Applying a role to an object.

Image Modified

Download the Roles training guide.

 
Sections within this topic:

  • [Creating a role
  • [Editing a role
  • [Deleting a role
  • [Applying a role to an object
  • [Object role application rules

Anchor
files_working_with_roles_htm_cre_2706
files_working_with_roles_htm_cre_2706
Anchor
_Toc517869443
_Toc517869443
Creating a role

To create a role:

  1. Choose the drop-down arrow to the far right of the menu bar.

...


Note: If you have several check boxes to mark, choose the Admin check box to mark all of the check boxes and then remove the marks you don't need.

  1. Choose OK.

Anchor
files_working_with_roles_htm_edi_9001
files_working_with_roles_htm_edi_9001
Anchor
_Toc517869444
_Toc517869444
Editing a role

To edit a role:

  1. Choose the drop-down arrow to the far right of the menu bar.

...

  1. In the Edit Role window, you can edit name, expiration date, and/or permissions.

  1. Choose OK.

Anchor
files_working_with_roles_htm_del_7240
files_working_with_roles_htm_del_7240
Anchor
_Toc517869445
_Toc517869445
Deleting a role

To delete a role:

  1. Choose the drop-down arrow to the far right of the menu bar.

...

  1. Choose Yes in the confirmation window.
  2. Choose OK.

Anchor
files_working_with_roles_htm_app_2563
files_working_with_roles_htm_app_2563
Anchor
_Toc517869446
_Toc517869446
Applying a role to an object

Roles can be applied to objects to limit a specific set of objects/devices to users who have been assigned to the same role. Users with the Admin role will be able to see all of the objects. Multiple roles may be applied to objects. The [Object role application rules table indicates if roles may be applied at the top level and the inheritance (if any) to children.

To apply a role to an object:
In this example, a role is applied to a Site.

  1. Choose the Configuration Explorer Image Removed Image Added icon, and then expand Campuses and then expand the campus name.  
  2. Right-click on the Site name.

...

  • Choose Yes and the children beneath this level will be updated to the roles applied at this level.
  • Choose No to return to the Object Role Editor and then choose Cancel to close the window.

Anchor
files_working_with_roles_htm_rol_7603
files_working_with_roles_htm_rol_7603
Object role application rules

There are different rules for the top-level objects and how (or if) a role affects the object's children.

 

Object

Apply to Top-Level

Inheritance to children

Additional information

Agents

Yes

All children

A role applied at any level is applied to children.

AutoReports

No

N/A

Roles cannot be applied to any children.

Campuses (Sites, Areas)

Yes

All children

A role applied at any level is applied to children

Energy

No

Inheritance depth is one level.

A role applied to sub-level 1 is applied to sub-level 2, but not to sub-level 2 children.

Profiles

No

Inheritance depth is one level.

A role applied to sub-level 1 is applied to sub-level 2, but not to sub-level 2 children.

Reports

No

No

Roles may only be applied to reports.
Note: You can apply the role to a folder, but users won't see any reports unless the report also has the role applied.

Watchdogs

No

Inheritance depth is one level.

A role applied to sub-level 1 is also applied to sub-level 2, but not to sub-level 2 children.

 
 
 

Anchor
files_creating_an_agent_htm
files_creating_an_agent_htm
Anchor
_Toc517869447
_Toc517869447
Creating an agent

  1. Choose the Configuration Explorer Image Removed Image Added icon, and then choose Agents on the tree on the left-hand pane.

...

  1. You can either choose the New Agent icon or you can right-click on the Agents folder and then choose New Agent.

Anchor
_Toc517869448
_Toc517869448
Tabs in this window:

  • [General Settings
  • [Tags
  • [Metadata
  • [Statistics
  • [Event Log
  • [Comm Alerts
  • [Remote Tunneling
  • [Location & Energy
  • [Signature Settings

Anchor
files_creating_an_agent_htm_gene_546
files_creating_an_agent_htm_gene_546
General settings

  1. On the General Settings tab, enter the Name and Description (optional) of the Agent.

...

  1. Choose the Connection Type and choose Edit.
  2. In the Connection Settings window, enter the settings as defined in [Scanning BAS Networks.
  3. Choose OK in the Edit Agent window to close the window.See [Licensing the Mini Agent to license the agent.

Anchor
files_creating_an_agent_htm_tags
files_creating_an_agent_htm_tags
Tags

Tags are used for additional miscellaneous identification.  A device may have a tag of 'first floor' or 'Area A'.  

Anchor
files_creating_an_agent_htm_meta_7857
files_creating_an_agent_htm_meta_7857
Metadata

Metadata is similar to tags, but contains a key (name) and a value. This can be used in reports.  For example, a VAV box might have a metadata for the 'BoxSize', and a value of 10.  

Anchor
files_creating_an_agent_htm_stat_3972
files_creating_an_agent_htm_stat_3972
Statistics

The Statistics tab is used to view the count of devices, objects, and trends for this agent. You can also view the overall performance.

Anchor
files_creating_an_agent_htm_even_5312
files_creating_an_agent_htm_even_5312
Event log

The Event Log tab allows you to monitor events related to this agent.

Anchor
files_creating_an_agent_htm_comm_4818
files_creating_an_agent_htm_comm_4818
Comm alerts

  1. Choose the Comm Alerts tab to enable/disable communication alerts. You can set this up so that the recipients receive an email notification based on when:
    • Hourly Average PPM is less than xx.
    • Hourly comm errors are above xx.
    • Average Load % is above xx.
  2. Choose the Signature Settings tab to enter the Signature Agent Access Key

Remote tunneling

See [Remote tunneling.
 

Anchor
files_licensing_the_mini_agent_h_4122
files_licensing_the_mini_agent_h_4122
Anchor
_Toc517869449
_Toc517869449
Licensing the mini agent

Image Modified

Download the Licensing the MiniAgent training guide.

 

  1. In Connect, choose the drop-down arrow located to the right of the menu icon, and then choose Mini Agent Licensing.

...

    • Job name
    • Zip Code
    • Misc. Notes
  1. Choose Send now.

Anchor
files_simple_connect_mini_agent__9703
files_simple_connect_mini_agent__9703
Anchor
_Toc517869450
_Toc517869450
Simple connect mini agent deployment

Assuming the network has internet access, DHCP enabled, and outbound ports open (see IT documentation), the following steps should allow the Mini Agent to reside on the BAS network and communicate directly with the KEY2ACT servers. If the following steps do not automatically turn the globe blue on the Connect UI, you may need to [assign a static IP address.

  1. Follow the steps in [Creating an agent.
  2. Plug Mini Agent into power source (120V).
  3. Locate network drop to connect the Mini Agent to the BAS network via Ethernet.
  4. Verify that the Agent connects to the KEY2ACT servers (when the globe turns blue) on the Connect UI.
  5. Once the Agent is connected, proceed to [Scanning BAS networks section.

Anchor
files_simple_connect_mini_agent__736
files_simple_connect_mini_agent__736
Anchor
_Toc517869451
_Toc517869451
Hiding/showing campuses

When you are on the Connect Home page, you can switch views to hide or display campuses. When a campus is hidden, you will see all your agents in the Agent Name column. With the campuses shown, agents are displayed beneath the campus their site is located.
Campuses off - Show Campuses button displayed

Campuses on - Hide Campuses button displayed

Anchor
files_assigning_a_static_ip_addr_6448
files_assigning_a_static_ip_addr_6448
Anchor
_Toc517869452
_Toc517869452
Assigning a static IP address to mini agent

In some BAS networks, DHCP is not enabled and the Mini Agent will not be able to [automatically be assigned an IP address. In this situation, a static IP address will need to be assigned to the Mini Agent.

  1. Connect PC, phone or tablet to Connect Mini Agent Wi-Fi hotspot.
  2. Enter the Wi-Fi password: c0nnecT7
  3. Open Browser on device.
  4. Go to 192.168.7.1:57000
  5. Enter the password: c0nnecT7
  6. Go to settings.
  7. Enter the IP address, subnet mask, and default gateway found in [Obtaining IP information from BAS network.

Anchor
files_obtaining_ip_information_f_2701
files_obtaining_ip_information_f_2701
Anchor
_Toc517869453
_Toc517869453
Obtaining IP information from BAS Network

  1. Plug the PC into the network drop for the Mini Agent.
  2. Choose Check Network Status.

...