- Installing the Connect User Interface (UI)
- Working with Users
- Working with Roles
- Creating an Agent
- Licensing the Mini Agent
- Simple Connect Mini Agent Deployment
- Assigning a Static IP Address to a Mini Agent
- Obtaining IP Information from a BAS Network
Installing the Connect User Interface (UI)
The following steps will facilitate installation of the Connect UI.
| Download the Installing and Licensing the UI User r training guide. |
- To install the Connect UI, go to the following link - Connect 2018_Setup.
- 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.
In the Welcome window, choose Install.
This will complete the Connect installation. Choose Finish.
- Launch Connect by double-clicking the Connect 2018 icon on the desktop.
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.
- Open Connect after receiving the email.
Enter username and temporary password.
Working with users
| Download the Users training guide. |
Creating a user
To create a new user
Choose the drop-down arrow to the far right of the menu bar.
Choose Edit Users/Roles.
- In the Users and Roles window, in the Users tab, choose Add.
Enter the Email Address of the user you are creating.
Note
Each user must have a unique email address.
Choose OK.
In the Create User window, choose Yes.
In the Edit User window, enter the Name and choose the Role for the user.
The Admin User role is the only installed role. For information on about roles, see [ Working with roles .
- Choose OK.
After the user is created, a success window displays. Choose OK.
The user needs to check their email inbox for an email containing their temporary password.
New user login and password change
The assumption is that the new user has installed Connect.
- Launch Connect.
Enter the user email address and temporary password.
- Choose the drop-down arrow to the far right of the menu bar.
Choose Change Password.
In the Change Password window, enter the current password and then enter the new password (twice).
- Choose OK.
- Choose OK in the Success window.
Forgot password
In the Login window, choose Forgot Password.
Choose Yes in the confirmation window.
Choose OK in the success window.
Note:
A message displays if the email address is not found in the database.
Note:
- Follow the steps in [ New_user_login_and_password_change .
Working with roles
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 .
| 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
Creating a role
To create a role:
Choose the drop-down arrow to the far right of the menu bar.
Choose Edit Users/Roles.
In the Users and Roles window, in the Roles tab, choose Add.
In the Edit Role window, enter the Name of the role you are creating.
- The Expires date defaults to one year from the current date, however you can edit this date. When the role expires, the user will no longer have access to Connect.
Under the Permissions section, choose the permissions that users assigned to this role will have.
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.
- Choose OK.
Editing a role
To edit a role:
Choose the drop-down arrow to the far right of the menu bar.
Choose Edit Users/Roles.
In the Users and Roles window, in the Roles tab, choose a role and then choose Edit.
In the Edit Role window, you can edit name, expiration date, and/or permissions.
- Choose OK.
Deleting a role
To delete a role:
Choose the drop-down arrow to the far right of the menu bar.
Choose Edit Users/Roles.
In the Users and Roles window, in the Roles tab, choose a role and then choose Delete.Users assigned to this role will not have log in Connect.
- Choose Yes in the confirmation window.
- Choose OK.
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.
- Choose the Configuration Explorer
icon, and then expand Campuses and then expand the campus name.
Right-click on the Site name.
- Choose Edit Roles.
In the Object Role Editor, mark/unmark the Can Read and/or Can Edit check boxes next to the roles.
Note:
Your user role will not be visible.
- Choose OK. All Areas beneath this Site will have the same roles applied.
- If you apply roles to a level above the Site, a message asks if it is okay to apply the changes to all of the selected objects, which are the children beneath the object that is selected based on the rules defined in the [ Object role application rules table.
- 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.
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. |
Creating an agent
Choose the Configuration Explorer
- You can either choose the New Agent
icon or you can right-click on the Agents folder and then choose New Agent.
Tabs in this window:
- [ General Settings
- [ Tags
- [ Metadata
- [ Statistics
- [ Event Log
- [ Comm Alerts
- [ Remote Tunneling
- [ Location & Energy
- [ Signature Settings
General settings
On the General Settings tab, enter the Name and Description (optional) of the Agent.
You can choose the Site for the agent by choosing Browse. Choose the site and then choose OK. You can also assign the Site later.
Note:
A Site can also be created on-the-fly when assigning a Site to an Agent.
- Choose the Connection Type and choose Edit.
- In the Connection Settings window, enter the settings as defined in [ Scanning BAS Networks .
- Choose OK in the Edit Agent window to close the window.See [ Licensing the Mini Agent to license the agent.
Tags
Tags are used for additional miscellaneous identification. A device may have a tag of 'first floor' or 'Area A'.
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.
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.
Event log
The Event Log tab allows you to monitor events related to this agent.
Comm alerts
- 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.
- Choose the Signature Settings tab to enter the Signature Agent Access Key
Remote tunneling
See [ Remote tunneling .
Licensing the mini agent
| Download the Licensing the MiniAgent training guide. |
In Connect, choose the drop-down arrow located to the right of the menu
icon, and then choose Mini Agent Licensing. 
In the Mini Agent Licenses window, choose the agent and then choose Assign Mini Agent.
In the Agent License Request window, choose Lookup to the right of Serial #.
- Enter the first 5 digits of the agent's serial number and then choose OK.
- Enter the following:
- Job name
- Zip Code
- Misc. Notes
- Choose Send now.
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 .
- Follow the steps in [ Creating an agent .
- Plug Mini Agent into power source (120V).
- Locate network drop to connect the Mini Agent to the BAS network via Ethernet.
- Verify that the Agent connects to the KEY2ACT servers (when the globe turns blue) on the Connect UI.
- Once the Agent is connected, proceed to [ Scanning BAS networks section.
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
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.
- Connect PC, phone or tablet to Connect Mini Agent Wi-Fi hotspot.
- Enter the Wi-Fi password: c0nnecT7
- Open Browser on device.
- Go to 192.168.7.1:57000
- Enter the password: c0nnecT7
- Go to settings.
- Enter the IP address, subnet mask, and default gateway found in [ Obtaining IP information from BAS network .
Obtaining IP information from BAS Network
- Plug the PC into the network drop for the Mini Agent.
Choose Check Network Status.
The Connect server port is auto-selected.
- Choose Check Network Settings.
Note the statuses of each of the ports. An icon displays to the right of each Connect port.
Verify the PC successfully obtained an IP address on the same subnet as the BAS.
Note:
If any of the ports cannot be accessed, or if an IP address was not successfully obtained, contact the system administrator to open the required ports and to reserve a static IP address.