KMC Software Application
Specifications
- Brand: KMC Controls
- Address: 19476 Industrial Drive, New Paris, IN 46553
- Phone: 877-444-5622
- Fax: 574-831-5252
- Website: www.kmccontrols.com
Accessing System Administration
To access the system administration, follow the steps outlined in the user manual.
Logging In at the Job Site
Instructions on how to log in at the job site can be found in the user manual.
FAQs
Q: How do I configure network settings?
A: To configure network settings, navigate to the corresponding section in the user manual and follow the step-by-step instructions provided.
Q: How can I create a custom dashboard?
A: Creating a custom dashboard involves adding and configuring dashboards, adding cards, modifying them, and managing decks. Refer to the user manual for detailed instructions.
Logging In at the Job Site
About Configuring On-Site Verses from the Cloud
Dashboards, schedules, trends, and alarms can be configured later from the Cloud as desired, but the following are the minimum functions to perform on-site (or performed as local via VPN):
l Configure Settings (especially local-only settings). (See Configuring Settings on page 9.)
Note: Cloud settings do not include these local-only settings: Network Interfaces (Ethernet, Wi-Fi, and Cellular), Date & Time, Whitelist/Blacklist, IP Tables, Proxy, and SSH settings), but those settings can be configured through a VPN.
l Recommended: Discover all known network devices and points (in Network Explorer) and set up profiles. (See Configuring Networks on page 35, Discovering Devices on page 41 and Assigning Device Profiles on page 41.) See “Configuring Networks”, “Discovering Devices”, and “Assigning Device Profiles” in the KMC Commander Software Application Guide. (See Accessing Other Documents on page 159).
Note: The Cloud can discover devices and points. However, discovery of devices and points on site will be helpful if network troubleshooting is required.
Logging In
Before Internet is established
Before an Internet connection is established for the gateway (see Configuring Network Interfaces), log in using WiFi:
1. In a (Google Chrome or Safari) browser window, log into KMC Commander using Wi-Fi (see Connecting Wi-Fi and Making Initial Login).
2. Enter your (case-sensitive) user Email and Password, as previously set up by a system administrator. (See Accessing System Administration on page 5.)
Note: If you forget your password, select Forgot password, enter your email address, and you will receive an email with a link for resetting your password.
3. Choose the relevant License (if more than one is available to you). Note: If the correct license is not available, see License and Project Problems on page 149.
4. Select Submit. Note: Networks Explorer
will appear.
Configure the settings as needed.
KMC Commander Software Application Guide
6
AG231019E
After Internet is established
After an Internet connection is established for the gateway (see Configuring Network Interfaces), log into the project Cloud at app.kmccommander.com. (See Logging Into the Project Cloud on page 8.)
KMC Commander Software Application Guide
7
AG231019E
Logging Into the Project Cloud
After an Internet connection has been established for the gateway (see Configuring Network Interfaces), logging into projects through the project Cloud is almost always recommended and can be done remotely.
1. Enter app.kmccommander.com in a web browser.
Note: Chrome or Safari are recommended.
2. Enter your KMC Commander Project Cloud Login email and password. 3. Select Login.
Note: For optional Google Single Sign On, Google credentials can be used for login if the Gmail credentials are entered as a new User in the System Administration (see Accessing System Administration on page 5).
4. Select your project from the drop-down list (if more than one).
Note: Project options are shown as Project Name (license name for the KMC CommanderIoT gateway). Multiple gateways may be part of a single project, such as in “My Big Project (IoT Box #1)”, “My Big Project (IoT Box #2)”, and “My Big Project (IoT Box #3).”
Note: A Google map with red pins can show the location of projects if the addresses are entered in the (Cloud) KMC license administration. (To use this feature, supply KMC Controls with your desired project address information for the license server.) Select a red pin, then Click to Continue to open that project.
Note: During initial setup, the (Internet) network connection must have a DHCP server to get an address, and the PC being used must be set to have a dynamic IP address rather than a static address.
Note: It may take several minutes before all cards and present values are visible.
Note: The cards that are viewable depend on the user’s access profile.
Note: The Settings section (gear icon) in the Cloud has fewer options than when connecting to the local gateway. (See Configuring Settings on page 9.)
Note: In a Cloud dashboard, cards can show points from devices from multiple KMC Commander (IoT gateway hardware) boxes if multiple boxes exist in the project.
KMC Commander Software Application Guide
Configuring Settings
Note: For your personal profile settings, see Changing Personal Profile Settings on page 133.
Configuring Project Settings
Accessing Project Settings
Go to Settings , then Project.
Under the Project Settings header
The name and time zone of the project (as set in the KMC Commander license server) shows here.
Auto Archive Alarms
1. Choose whether or not to auto archive alarms. If you choose On: l Alarms that are acknowledged in Alarm Manager will be archived after the number of hours (1 minimum) entered in Acknowledged and Older Than (Hours). l All alarms, whether acknowledged or not, will be archived after the number of days (1 minimum) entered in Any Alarm Older Than (Days). l Archived alarms can be hidden or viewed. (See Finding, Viewing, and Acknowledging Alarms on page 116.)
2. Select Save.
Dashboard
Point ID Column from Card Detail 1. Choose to either Show or Hide the Point ID column from the backs of cards on dashboards. 2. Select Save.
Dashboard Deck Mode 1. From the dropdown menu, select the default view mode for decks on dashboards.
Note: Individual decks can be changed from the default to another view mode (see Switching Between Deck View Modes on page 79) However, whenever a dashboard reloads, the decks will return to this default. Also, when you add a deck to a dashboard it will appear in this view mode.
2. Select Save.
Read Time After Point Writes (Seconds) The value entered here is the seconds interval after the system writes a point that it will read the new value.
KMC Commander Software Application Guide
9
AG231019E
Note: Typically the system writes to a point within half a minute (depending on network speed and other factors), but a read confirmation of the successful write (e.g., a setpoint displayed on a card changes from the old value to the new value) may take several minutes. If errors are occurring when reading, adding an extra time interval may help reduce errors.
1. If desired, enter a custom interval (in seconds). 2. Select Save.
Display Point Override 1. Choose whether an indication should display on cards that a point is in override. If you choose On: l A border (together with a hand icon), colored the Point Override Color on page 10, will appear around the slot of an overridden point. l Hovering over the point’s name will cause information about the override to appear.
Note: The override indication will display when a point’s value is written at the same or higher priority than the Default Manual Write Priority on page 15 setting, found in Settings > Protocols.
2. Select Save.
Point Override Color 1. If Display Point Override on page 10 is On, do one of the following to choose a color for the override indication: l Select a color, using the color selector square and slider. l Enter the desired color’s hex code in the text box.
Note: To revert the color back to the default (deep pink) color, select the “here” in the tip text.
2. Select Save.
Fixed Dashboard Width The default setting is Auto (i.e. responsive) — dashboard element arrangements shift for different sized device screens and browser windows. Setting the width to a fixed number of columns can help dashboard elements to remain in intentional arrangements. To set a standard fixed with for all existing and new dashboards.
1. From the dropdown menu, select the desired number of columns, or enter the number.
Note: A column is the width of one medium-sized card (for example, one Weather card).
2. Select Save.
KMC Commander Software Application Guide
10
AG231019E
Note: A Dashboard Width set for an individual dashboard overrides the Fixed Dashboard Width set here. (See Setting a Dashboard’s Width on page 52.)
Note: Elements on an preexisting dashboard without an individually set Dashboard Width may shift from an intended arrangement to accommodate the new Fixed Dashboard Width.
Note: A left-right scroll bar will appear for dashboards on narrower screens and browser windows.
Measurements
1. From the dropdown menu, select the default unit type (Metric, Imperial, or Mixed) to use for displaying point values on cards, trends, etc.
2. Select Save.
Security
Session Inactivity Timeout 1. From the dropdown menu, select the duration of time that no activity can be detected before requiring a login again.
Note: None means that the session will never timeout due to inactivity.
2. Select Save.
Minimum password length required 1. Enter the desired minimum number of characters to require for a password. 2. Select Save.
Running Jobs
Running Jobs is a diagnostic tool showing a snapshot of any current processes. Most processes are completed within a few minutes. During initial discovery of a large network, processes may last considerably longer. Any job that lasts more than a few hours, however, is probably stuck. Canceling a “stuck” or pending job (from app.kmccommander.com)
1. Select Delete next to the running job. 2. In the Delete Running Job dialog, select Reboot and Delete.
Note: A countdown timer appears for 2 minutes and 30 seconds in an orange box at the bottom of the screen (over the Save button) while the KMC Commander gateway reboots.
KMC Commander Software Application Guide
11
AG231019E
Note: To access the Save button during the reboot process, you can close the countdown timer. The reboot process will still continue.
3. If you need to cancel more running jobs, select Delete next to them.
Note: If deleted during the 2 minutes and 30 seconds that the gateway is rebooting, the jobs will delete without needing to confirm.
Gateway Information
Element
Box Service Tag Last logged communication time Data usage
Reboot Gateway
Meaning / Additional Information
Matches the service tag number found on the bottom of the gateway of the project currently accessed. It is the last seven digits, after “CommanderBX”.
Shows the time of the last logged communication at the time that the web browser loaded the page.
Shows the year and month (the last complete month) for which data usage information is displayed, as well as the amount of received data (RX) and transmitted data (TX) in gibibytes (GiB).
Selecting Reboot Gateway initiates rebooting of the KMC Commander gateway. A timer counts down for 2 minutes and 30 seconds, during which Reboot Gateway is unavailable.
Note: The gateway must have a Cloud connection to perform a remote reboot.
License Information
Element
Name Expiration Date
Automated Billing
Licensed Points
Meaning / Additional Information
The project name associated with the license in the KMC Commander license server.
See “How Does Licensing Work?” in the KMC Commander (Dell or Advantech gateway) data sheet for details.
Contact a KMC Controls sales representative or customer service to turn automated billing on or off. See Contact Information on page 161.)
The maximum number of points of interest that can be trended and/or written to by KMC Commander under the current license.
KMC Commander Software Application Guide
12
AG231019E
Element
Meaning / Additional Information
Used Points
The number of data points currently configured to be trended and/or written to by KMC Commander as points of interest.
System Integrator
The name of the System Integrator associated with the project in the KMC Commander license server displays here.
Enabled Addons
A list of the add-ons (extra features) purchased for this license displays here. (See Add-ons (and Data Explorer) on page 136.)
Configuring Protocol Settings
Accessing Protocol Settings
Go to Settings , then Protocols.
Individual Point Intervals
The Point Update Wait Interval (Minutes) on page 15 determines the default trending frequency for all points of interest in the project. However, project needs may require some points to trend at a lower or higher frequency. For those cases, you can configure Low, Medium, and High options (independent of the Point Update Wait Interval). When Assigning Device Profiles on page 41 or Editing a Device Profile on page 43, you can then select the Low, Medium, or High option from a Trending Frequency drop-down menu for the required points.
Low
Low configures the Low option of the Trending Frequency drop-down menu (found when Assigning Device Profiles on page 41).
1. Enter the longer interval (in minutes) at which some points in the project need updated (polled).
Note: The longest interval allowed is 60 minutes.
2. Select Save.
Medium
Medium configures the Medium option of the Trending Frequency drop-down menu (found when Assigning Device Profiles on page 41).
1. Enter the medium interval (in minutes) at which some points in the project need updated (polled).
Note: Medium is independent of the Point Update Wait Interval (Minutes) on page 15 (the default point polling interval for all points of interest in the project).
2. Select Save.
KMC Commander Software Application Guide
13
AG231019E
High High configures the High option of the Trending Frequency drop-down menu (found when Assigning Device Profiles on page 41).
1. Enter the shorter interval (in minutes) at which some points in the project need updated (polled).
Note: The shortest interval allowed is 0.5 minutes.
2. Select Save.
BACnet
Device Instance The device instance of the local KMC Commander gateway can be changed here.
Note: A manual restart is required for a change to take effect.
To change the device instance: 1. Enter a new device instance. 2. Select Save.
Max Invoke ID The KMC Commander gateway uses the Max Invoke ID to send multiple requests without waiting for responses, until the Invoke ID limit (the entered value) is reached.
Note: A value of 1 means the KMC Commander gateway will always wait (or timeout) for a response before setting the next request in its queue.
Caution: The KMC Commander gateway will use multiple UDP ports for its Source Port in sending messages if greater than 1. It will always use the configured UDP port to talk to devices, but will use different UDP ports to receive the responses. These ports start with 47808 and go up consecutively. Do not set Invoke ID to anything greater than 1 if your firewall blocks these ports.
To change the Max Invoke ID (from the default of 1): 1. Enter a new value (1 to 5 maximum requests). 2. Select Save.
Read Priority Array Wait Interval (Minutes) The Read Priority Wait Interval is the time between updates (polling) of priority array values.
Note: This interval affects how quickly an indication that a point is in override might display on cards. (See Display Point Override on page 10 in Settings > Project.) It also affects how up-to-date Manual Override reports will be. (See Configuring a Manual Override Report on page 124.)
KMC Commander Software Application Guide
14
AG231019E
To change the Read Priority Array Wait Interval (from the default of 60 minutes): 1. Enter a new value (0 to 180 minutes).
Note: Setting to 0 will disable the priority array reading daemon (background polling process) and values will not update.
2. Select Save.
BACnet/Niagara
Point Update Wait Interval (Minutes) The Point Update Wait Interval is the default time between updates (polling) of points on trends, alarms, and any reads through an API. To change the Point Update Wait Interval (from the original default of 5 minutes):
1. Enter a new value (1 to 60 minutes). 2. Select Save.
Note: Niagara settings can take up to 15 minutes to take effect.
Manual Write Timeout Manual Write Timeout sets the default choice of duration for any manual overrides made of setpoints or other objects on dashboards.
Note: The default duration is Permanent, meaning manual overrides will continue indefinitely until the next schedule change or manual override occurs.
To set the Manual Write Timeout : 1. Select the manual override duration (15 minutes to 1 week) from the dropdown list. 2. Select Save.
Note: Niagara settings can take up to 15 minutes to take effect.
Default Manual Write Priority Default Manual Write Priority sets the default BACnet priority choice used to write manual changes from the dashboard. To change the Default Manual Write Priority (from the default of 8):
1. Enter a new BACnet priority value. 2. Select Save.
Note: Niagara settings can take up to 15 minutes to take effect.
KMC Commander Software Application Guide
15
AG231019E
Schedule Write Priority Schedule Write Priority is the BACnet priority used to write normal (i.e., not holiday) schedule events.
Note: If KMC Commander schedules will be used to control devices, this value must be higher than the default schedule write priority values in the controlled devices. (See Managing Schedules and Events on page 90.)
To change the Schedule Write Priority (from the default of 16): 1. Enter a new BACnet priority value. 2. Select Save. Note: Niagara settings can take up to 15 minutes to take effect.
Holiday Schedule Write Priority Holiday Schedule Write Priority is the BACnet priority used to write holiday schedule events.
Note: If KMC Commander schedules will be used to control devices, this value must be higher than the default schedule write priority values in the controlled devices. (See Managing Schedules and Events on page 90.)
To change the Holiday Schedule Write Priority (from the default of 15): 1. Enter a new BACnet priority value. 2. Select Save. Note: Niagara settings can take up to 15 minutes to take effect.
Override Schedule Write Priority Override Schedule Write Priority is the BACnet priority used to write override schedule events. To change the Override Schedule Write Priority (from the default of 8):
1. Enter a new BACnet priority value. 2. Select Save.
Note: Niagara settings can take up to 15 minutes to take effect.
KMDigital
Note: KMC Commander supports KMDigital through use of a KMD-5551E translator.
Manual Write Priority (KMD Devices) This is the priority used to write manual changes from the dashboard to KMDigital devices through the translator.
KMC Commander Software Application Guide
16
AG231019E
Note: KMDigital controllers have only manual or auto write “priorities.” The translator enables a virtual priority array on the KMDigital device points by mapping them inside the translator. Auto (priority 0) is the default behavior for KMDigital, and setting any other priority will write to the KMDigital device in manual mode. See the “Translation concepts” section in the KMD-5551E translator’s application guide for more information.
To change the Manual Write Priority (from the default 0 [Auto]): 1. Enter a new priority value. 2. Select Save.
Schedule Write Priority (KMD Devices) This is the priority used to write schedule events to KMDigital devices through the translator.
Note: KMDigital controllers have only manual or auto write “priorities.” The translator enables a virtual priority array on the KMDigital device points by mapping them inside the translator. Auto (priority 0) is the default behavior for KMDigital, and setting any other priority will write to the KMDigital device in manual mode. See the “Translation concepts” section in the KMD-5551E translator’s application guide for more information.
To change the Schedule Write Priority (from the default 0 [Auto]): 1. Enter a new priority value. 2. Select Save.
Miscellaneous
Shorten JACE Format Point Names 1. For Niagara Networks, choose whether or not to automatically shorten JACE format point names: l If turned Off, each point name read from a JACE can be extremely long and include a variety of additional device information.
l If turned On, (the default) the name shortens to just the names of the points themselves (i.e. the third-tolast and last segments of the object name).
2. Select Save.
SNMP MIB Files
To upload a MIB file for SNMP devices: 1. Select Upload. 2. In the Upload SNMP window, select Choose file. 3. Locate the MIB file. 4. Select Upload.
KMC Commander Software Application Guide
17
AG231019E
Adding and Configuring Users
Adding a User
1. Go to Settings , Users/Roles/Groups, then Users. 2. Select Add New User. 3. In the Add New User window, enter the First Name, Last Name, and Email address of the user. 4. Select the user’s Role from the dropdown menu.
Note: Permissions for roles are defined in the Roles settings. (See Configuring Roles on page 23.)
5. Enter the user’s Office Phone and Cell Phone.
Note: If you want the user’s cell phone to be used for SMS alarm messages, switch on Use Cell Phone for SMS.
6. If Alarm Groups have been set up, you can (optionally) assign the user to one now from the dropdown. (See Configuring (Alarm Notification) Groups on page 25.)
7. Select Add.
Note: The new user appears in the list (displayed under Users).
Note: For information on how to add multiple user instances to multiple projects using a .xlsx (Microsoft Excel) file, see Bulk Editing Users on page 19.
Configuring a User’s Topology Access
Once a site typology has been set up in Site Explorer (see Creating a Site Topology on page 45), you can allow a user to access certain devices and not others.
Note: Access to all devices is the default.
To edit a user’s topology access: 1. After Adding a User on page 18, from the right end of the user’s row, select Edit Topology . 2. In the Edit Topology Access window: o To remove the user’s access to devices, clear the checkbox in front of the device, zone, floor, building, or site. o To grant the user access to devices, select the checkbox in front of the device, zone, floor, building, or site.
KMC Commander Software Application Guide
18
AG231019E
Note: Clearing a checkbox for a zone, floor, building, or site will automatically clear check boxes for all the devices underneath it in the topology.
Caution: Administrators who clear devices in their own profiles and save their profiles will not be able to see those devices again to restore their own access. Another administrator, however, may be able to restore the other’s access. Otherwise, the device will need to be rediscovered as a new device.
3. Select Apply at the bottom (you may need to scroll down to see it).
Editing Users
Editing a User
1. Go to Settings > Users/Roles/Groups > Users. 2. In the row of the user that you want to edit, select Edit User . 3. In the Edit User window, modify the user configuration as needed. (See Adding and Configuring Users on
page 18 for more information). 4. Select Save.
Bulk Editing Users
You can bulk edit multiple user instances for multiple projects by uploading a .xlsx (Microsoft Excel) file. The feature helps you manage all users for all projects under the control of your System Integrator account. To avoid confusion and throwing errors (see Error Messages on page 23) we recommend that you:
l Download a fresh, current template immediately prior to bulk editing users. (See Download and open the template on page 19.)
l Do not allow other users on your team to upload your template file–have them download their own template file.
Access the Bulk User window 1. Go to Settings > Users/Roles/Groups > Users. 2. Select Bulk User Edit, which opens the Bulk User window.
Note: Though you access the Bulk User window from within a single project, the feature helps manage all users for all projects under the control of your System Integrator account.
Download and open the template 1. Select Download Template with Current Users.
KMC Commander Software Application Guide
19
AG231019E
Note: This causes the template file–bulk-user-edit-template.xlsx–to generate. The template contains the configurations of all users for all projects under the control of your System Integrator account (at that moment).
2. Locate and open the template file.
Note: The template file–bulk-user-edit-template.xlsx–downloads to the place your browser designates for file downloads.
3. Enable editing of the template file.
Continue by Adding User Instances on page 20, Deleting User Instances on page 21, and/or Changing Users’ Roles on page 21.
Adding User Instances
1. In a new row of the spreadsheet, fill out the columns:
Column Label
Explanation
Required?
Enter the first name of the user that you want to
firstName
Yes
add.
Enter the last name of the user that you want to
lastName
Yes
add.
Enter the email address of the user.
Yes
Enter the role that you want the user to have.
role
(See Configuring Roles on page 23 for more
Yes
information.)
Enter the identification code of a project that you want to add the user to. (You can copy the projectId from another user row where it is already associated with the projectName that you know.)
projectId
If you want to add the user to multiple projects, fill out multiple rows–one for each
Yes
project.
Note: The projectId is the unique identifier to ensure that the system finds the exact project.
KMC Commander Software Application Guide
20
AG231019E
Column Label
Explanation
Required?
You can copy the projectName from another
user row for consistency. However, if you
upload the .xlsx file with the projectName blank,
the system will automatically fill in the
projectName associated with the projectId. (If
you then Download and open the template
on page 19 again, you will see the projectName
projectName
filled in.)
No
Note: If you enter the projectName but leave the projectId blank, the user cannot be added. (The projectId is the unique identifier to ensure that the system finds the exact project.)
delete
Enter FALSE, or leave blank.
No
The user will receive an invitation or notification
sendNotificationEmail
No
email if you enter TRUE.
2. Repeat step 1 for as many user instances as you want to add in one bulk user edit. When you are done modifying the spreadsheet, Save and upload the file on page 22. Deleting User Instances
1. In the row of each user instance that you want to delete, enter TRUE in the delete column.
Note: If you want to completely remove a user from KMC Commander, enter TRUE in the delete column for every instance of that user associated with any project.
2. If you want a user to receive an email notifying them that they were removed from a project, enter TRUE for sendNotificationEmail.
When you are done modifying the spreadsheet, Save and upload the file on page 22.
Changing Users’ Roles
1. For each user instance that you want to change, enter an alternative, valid role in the role column. (See Configuring Roles on page 23 for more information.)
2. If you want a user to receive an email notifying them that their role was updated for that project, enter TRUE for sendNotificationEmail.
When you are done modifying the spreadsheet, Save and upload the file on page 22.
KMC Commander Software Application Guide
21
AG231019E
Save and upload the file 1. Save the .xlsx file. Note: You can save the file with a new name; the system will still accept it.
2. In the Bulk User window of KMC Commander, select Choose file. 3. Locate and select the saved file. 4. Choose whether or not the system should Stop process on errors.
Note: If Stop process on errors is checked, the system will not process any rows after an error occurs.
5. Select Upload.
Note: This causes an output file–output.xlsx–to generate. It downloads to the place your browser designates for file downloads.
6. Check the output file for Success Messages on page 22 and Error Messages on page 23. Success Messages
successMessage
Explanation
User invited successfully
You invited an entirely new user to KMC Commander with this project.
User added successfully User removed successfully
You invited an existing user (of at least one project) to another project.
You removed a user from a project. (To completely remove a user from KMC Commander, repeat for all of their projects.)
User is already removed from the project
You tried to remove a user instance that was already removed. (Relax.)
User role updated successfully
You updated a user’s role for a project.
Duplicated row, no action taken
You accidentally made two identical rows in the file. The action was taken the first time. (Relax.)
KMC Commander Software Application Guide
22
AG231019E
Error Messages
errorMessage
Missing required fields
Project not found
User does not have access to project
User does not exist Role does not exist
Explanation / Remedy
Fill out (at minimum) firstName, lastName, email, role, and projectId.
Enter a valid projectId. Copy and paste the needed projectId from an existing row.
The “user” in this case is you. You do not have access to the project associated with the projectId that you entered. Or you have access, but are assigned a role without Admin permissions. Obtain access (with Admin permissions) from an Admin of that project.
You tried to delete a user who does not exist in the system (relax). If intended to add the user, enter FALSE for delete.
Enter a role that is configured for the project. (See Configuring Roles on page 23.)
Configuring Roles
Adding a New Role
KMC Commander comes with four preset roles (Admin, Owner, Technician, and Occupant). In addition, you can create custom roles. To create a new custom role:
1. Go to Settings , Users/Roles/Groups, then Roles. 2. Select Add New Role. 3. Enter a name for the new role. 4. Select Add. 5. Define that role by choosing the features you want to give that role access to. (See Defining Roles on page
24.) 6. Select Save.
KMC Commander Software Application Guide
23
AG231019E
Defining Roles
1. Go to Settings , Users/Roles/Groups, then Roles. 2. Choose the KMC Commander features that you want to give a role access to (see the table below) by checking
the boxes for those features in the row for that role. 3. Select Save.
Note: To apply a role to a user, see Adding and Configuring Users on page 18.
Note: The Admin role is permanently set to have Admin permissions, giving those users access to all features (including Settings ).
Note: See Configuring a User’s Topology Access on page 18 for information on that separate process.
Column Label
Admin Dashboard Networks Schedules Alarms Trends
What it Does
If Admin permissions are selected for a role, those users will have full access to all features (including Settings ), whether the other features’ checkboxes are selected or not.
Selecting this for a role gives those users access to Dashboards (which displays cards and decks). Clearing this hides Dashboards from their side navigation menu. (See Dashboards and Their Elements on page 51.)
Selecting this for a role gives those users access to Networks . Clearing this hides Networks from their side navigation menu. (See Configuring Networks on page 35.)
Selecting this for a role gives those users access to Schedules . Clearing this hides Schedules from their side navigation menu. (See Managing Schedules and Events on page 90.)
Selecting this for a role gives those users access to Alarms . Clearing this hides Alarms from their side navigation menu.(See Managing Alarms on page 107.)
Selecting this for a role gives those users access to the Trends setup. Clearing this hides Trends from their side navigation menu. (They can still view trend cards on a dashboard.) (See Managing Trends on page 98.)
KMC Commander Software Application Guide
24
AG231019E
Column Label
Data Explorer Hide Card Detail Read Only
Dashboard Autoshare
What it Does
Selecting this for a role gives those users access to Data Explorer. Clearing this hides Data Explorer from their side navigation menu (in Add-ons ). (See Using Data Explorer on page 136.)
If selected for a role, those users will not be able to flip over dashboard cards.
If selected for a role, those users will only be able to view (not edit) dashboards.
The dashboards of the user that you select from the dropdown list (the source user) will be autoshared (copied) as templates with any new users given this role. When new users with this role are added to the project, their dashboards will populate with the templates (as they are at that moment). Subsequent changes by the source user to the dashboards will not reflect in the accounts of the users that they were autoshared with. Likewise, the new users can modify the populated dashboards without affecting the source user’s templates. It is recommended to make template accounts to serve as the source “user”, rather than using an individual’s account.
Configuring (Alarm Notification) Groups
Adding a Group Name
1. Go to Settings , Users/Roles/Groups, then Groups. 2. Select Add New Group. 3. Enter a name for the group. 4. Select the Add New Group.
Note: When you are done adding new group names, you can close the tool from the far right of the row.
5. Continue by Adding Users to a Group on page 25.
Adding Users to a Group
1. After Adding a Group Name on page 25, select Edit
in the group’s row.
2. In the Edit [Group Name] window, select the checkboxes next to the users you want to include in the group.
KMC Commander Software Application Guide
25
AG231019E
Note: You can sort the list of names by choosing an option (Email domain, Email, First Name, Last Name, or Role) from the Sort By dropdown menu. You can also narrow the list by entering a name, email, or role in the search field.
3. Select Save. For a user to receive an alarm notification, their Notification Group must be selected when Configuring a Point Value Alarm on page 107.
Configuring Weather Settings
Accessing Weather Settings
Go to Settings , then Weather.
Temperature
Select Fahrenheit or Celsius to set the temperature unit type that will display on weather cards.
Weather stations
For Weather cards on the Dashboard, you must first add weather stations to this list. The listed weather stations will appear in a dropdown list on Weather cards. To add a new station:
1. Select Add New Station. 2. Choose whether to search by City or ZIP code.
Note: If searching by City, make sure the country the city is located in is selected from the dropdown menu (US = United States; AU = Australia; CA = Canada; GB = Great Britain; MX = Mexico; TR = Turkey)
3. Enter the city’s name or the ZIP code. 4. Choose the desired city from the list that appears. 5. Select Add.
Searching User Action Logs
User action logs allow viewing of when modifications were made by a user (or by API calls) to networks, profiles, devices, schedules, and writable points.
Accessing User Action Logs
Go to Settings , then User Action Logs.
Finding User Actions
The most recent changes are at the top of the list. Use the forward arrow at the bottom to see older action log pages.
KMC Commander Software Application Guide
26
AG231019E
Note: In the Object (Name) column, the first word is the Object Type (e.g., network, point, schedule) and the text inside the parentheses is the Object Name.
To narrow the list by a user’s first or last name: 1. Enter the User First Name and/or User Last Name. 2. Select Apply.
To narrow the list by a date range: 1. Select the Time Range field. 2. Choose an earliest date. 3. Choose a latest date. 4. Select Ok. Note: Selecting Clear clears the date range.
5. Select Apply.
To apply a filter to the list: 1. Select Select Filters. 2. Enter descriptions in the desired fields (for example, point (),device (), network (), schedule (), or profile () in the Object field). 3. Select the checkbox next to the description. 4. Select Apply.
Configuring LAN/Ethernet Settings
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site.
Network Interface Port Labeling
The network interface ports are labeled differently depending on the model of KMC Commander gateway:
Dell Edge Gateway 3002
Ethernet 1 [eth0]
Ethernet 2 [eth1]
Wi-Fi [wlan0]
Advantech UNO-420
LAN B [enp1s0] (PoE In)
LAN A [enps2s0]
Wi-Fi [wlp3s0]
Configuring the LAN/Ethernet Settings
Only one LAN/Ethernet port should have a live Internet connection. The ports should not have the same IP addresses.
KMC Commander Software Application Guide
27
AG231019E
1. Go to Settings , Network Interfaces, then LAN B [enp1s0] (PoE In) / Ethernet 1 [eth0], or LAN A [enp2s0] / Ethernet 2 [eth1].
2. Switch Disabled to Enabled (if not already).
3. Enter the information in the boxes below as needed.
4. Choose the Network Area Type (LAN or WAN).
5. If the gateway will primarily access the cloud through a cellular connection and you are configuring this Ethernet port for connection to a local subnet, choose yes for either Isolate IPv4 to Local Subnet or Isolate IPv6 to Local Subnet.
Caution: If your local connection is routed and you select yes, it may disable your ability to connect to the gateway locally.
6. Select Save.
Configuring Wi-Fi Settings
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site.
Know Before Beginning
Wi-Fi Uses
Wi-Fi is usually used as an access point only for installation, then is turned off. See Turning off Wi-Fi (after installation) on page 28. Wi-Fi may continue to be used as an access point. However, in that case the password should be changed from the factory default. See Changing the passphrase (password) to continue using Wi-Fi as an access point on page 29. Wi-Fi can also be used as a client after installation to connect to an existing Wi-Fi network. See Using Wi-Fi (as a client) to connect to an existing Wi-Fi network on page 29.
Network Interface Port Labeling
The network interface ports are labeled differently depending on the model of KMC Commander gateway:
Dell Edge Gateway 3002
Ethernet 1 [eth0]
Ethernet 2 [eth1]
Wi-Fi [wlan0]
Advantech UNO-420
LAN B [enp1s0] (PoE In)
LAN A [enps2s0]
Wi-Fi [wlp3s0]
Turning off Wi-Fi (after installation)
1. Go to Settings , Network Interfaces, then Wi-Fi [wlp3s0] / Wi-Fi [wlan0]. 2. Switch Enabled to Disabled. 3. Select Save.
KMC Commander Software Application Guide
28
AG231019E
Changing the passphrase (password) to continue using Wi-Fi as an access point
1. Go to Settings , Network Interfaces, then Wi-Fi [wlp3s0] / Wi-Fi [wlan0]. 2. Leave the switch on Enabled. 3. Leave Access Point selected for AP Mode. 4. Edit the Wi-Fi information as needed.
Note: KMC Commander has a built-in DHCP server. Using DHCP Range Start and DHCP Range End, set the range of available addresses for devices to connect to the access point.
5. Change the default Passphrase (a.k.a. password).
Note: The new password should have at least eight characters, be mixed case, and use at least one number.
6. Record the new password and any new addresses. 7. Switch Internet Sharing to either Enabled or Disabled.
Note: If Enabled, devices connected to the KMC Commander gateway by this wireless access point can access the Internet through the gateway, in addition to accessing the KMC Commander user interface.
Note: If Disabled, devices connected to the KMC Commander gateway by this wireless access point will be able to access the KMC Commander user interface only.
8. Select Save.
Using Wi-Fi (as a client) to connect to an existing Wi-Fi network
1. Go to Settings , Network Interfaces, then Wi-Fi [wlp3s0] / Wi-Fi [wlan0]. 2. Switch Enabled to Disabled. 3. Select Save. 4. Restart the gateway. (See Restarting the Gateway on page 157.) 5. Return to Wi-Fi [wlp3s0] / Wi-Fi [wlan0]. 6. Switch Disabled back to Enabled. 7. For AP Mode, choose Client. 8. For Type, choose DHCP or Static as needed. 9. Edit the Wi-Fi information as needed.
KMC Commander Software Application Guide
29
AG231019E
10. Select Save.
Note: While in Client mode, selecting Show available networks shows information about all Wi-Fi signals that the KMC Commander gateway is receiving.
Configuring Cellular Settings
Note: Cellular setting are only available on KMC Commander Dell cellular model gateways supplied with a SIM card.
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site. Only one port (Ethernet or cellular, but not both) should have a live Internet connection.
1. Activate the supplied SIM card and install the cellular antennas if this has not already been done.
Note: See “Installing Optional Cellular and Memory” in the KMC Commander Dell Gateway Installation Guide.
2. Go to Settings , Network Interfaces, then Cellular [cdc-wdm0]. 3. Switch Disabled to Enabled (if not already). 4. Enter the Access Point Name (APN) supplied by the cellular carrier.
Note: Usually the APN will be “vzwinternet” for Verizon or “broadband” for AT&T. For a Verizon static IP, it will be a variation of ‘xxxx.vzwstatic'” dependent on location.
Note: Leave the Route Metric (Priority) at its default.
5. Select Save.
Note: When a cellular connection is made, an IP address appears.
Configuring Date and Time Settings
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site. During installation, if the network does not provide an initial NTP time service, a different time server can be entered here to allow initial setup of the system.
Selecting a Time Zone
1. Go to Settings , Network Interfaces, then Date & Time.
2. Switch Disabled to Enabled (if not already).
KMC Commander Software Application Guide
30
AG231019E
3. From the Time Zone dropdown list, choose a time zone. (See About UTC Time Zones on page 31.)
Note: To narrow the list of time zones, clear the text in the dropdown list selector, then enter a geographical area.
4. Select Save.
Note: The project time zone can also be set under Projects in KMC Commander System Administration. See Accessing System Administration on page 5.
Entering an NTP (Network Time Protocol) Server
Note: An NTP server provides accurate, synchronized time.
1. Go to Settings , Network Interfaces, then Date & Time. 2. For NTP Server, enter the server’s address.
Note: Leave the NTP Fallback Server default address (ntp.ubuntu.com) unless a definite alternative is known.
3. Select Save.
About UTC Time Zones
UTC (Coordinated Universal Time) is also known as GMT (Greenwich Mean Time), Zulu, or Z time. KMC Commander may display the date (for example, 2017-10-11) and the time in 24-hour UTC format (for example, T18:46:59.638Z, which means 18 hours, 46 minutes, and 59.638 seconds in the Coordinated Universal Time zone). UTC is, for example, 5 hours ahead of Eastern Standard Time or 4 hours ahead of Eastern Daylight time.
See the table below for more time zone conversions:
Sample Time Zones*
Offset from UTC (Coordinated Universal Time) to Equal Local Time**
American Samoa, Midway Atoll
UTC–11hours
Hawaii, Aleutian Islands
UTC–10hours
Alaska, French Polynesia
UTC–9 hours (or 8 hours with DST)
USA/Canada Pacific Standard Time
UTC–8 hours (or 7 hours with DST)
USA/Canada Mountain Standard Time
UTC–7 hours (or 6 hours with DST)
USA/Canada Central Standard Time
UTC–6 hours (or 5 hours with DST)
USA/Canada Eastern Standard Time
UTC–5 hours (or 4 hours with DST)
KMC Commander Software Application Guide
31
AG231019E
Sample Time Zones*
Offset from UTC (Coordinated Universal Time) to Equal Local Time**
Bolivia, Chile Argentina, Uruguay United Kingdom, Iceland, Portugal Europe (most countries) Egypt, Israel, Turkey Kuwait, Saudi Arabia United Arab Emirates Maldives, Pakistan India, Sri Lanka Bangladesh, Bhutan Laos, Thailand, Vietnam China, Mongolia, Western Australia Korea, Japan Central Australia Eastern Australia, Tasmania Vanuatu, Solomon Islands New Zealand, Fiji
UTC–4 hours UTC–3 hours 0 hours UTC +1 hour UTC +2 hours UTC +3 hours UTC +4 hours UTC +5 hours UTC +5.5 hours UTC +6 hours UTC +7 hours UTC +8 hours UTC +9 hours UTC +9.5 hours UTC +10 hours UTC +11 hours UTC +12 hours
*Minor parts of the named areas may be in other time zones.
**May also need to convert from 24 to 12 hour format. Zulu or Greenwich Mean Time is the same as UTC for practical applications.
Configuring Whitelist/Blacklist Settings
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site.
KMC Commander Software Application Guide
32
AG231019E
Know Before Beginning
Caution: Deleting any of the default listings is not recommended. Deleting the wrong listing could result in loss of communication with the gateway.
For both Ethernet ports, the default setting for Whitelist/Blacklist Network Area Type is LAN. A LAN (Local Area Network) is generally not publicly accessible on the Internet. A WAN (Wide Area Network) generally is. The whitelist contains addresses that are always allowed inbound access, and the blacklist contains addresses that are never allowed inbound access. The whitelist and blacklist apply only to unsolicited inbound requests. Outbound messages have no blocks. Addresses and ports can be added to the whitelist. For BACnet, the UDP port for traffic may need to be added to the UDP Port (Whitelist) section if it is not already in the list. For remote access into a gateway via VPN, the VPN subnet might need to be added to the LAN whitelist. Add a subnet as a range of addresses, not a single address. For IP addresses, enter an address or a range, with the range defined with the subnet mask length using CIDR (Classless Inter-Domain Routing) notation. (For example, enter the base address, followed by a slash, and then the subnet mask length as the number of most significant bits of the IP address, such as 192.168.0.0/16.)
Adding an IP Address to a Whitelist or Blacklist
1. Go to Settings , then Whitelist/Blacklist.
2. Select the IP Address box that is below Whitelist IP or Blacklist IP for the network type (LAN or WAN) that you want to add the address to.
3. Enter the IP address.
Note: To enter a range of IP addresses, define the range with the subnet mask length using CIDR notation. (For example, enter the base address, followed by a slash, and then the subnet mask length as the number of most significant bits of the IP address, such as 192.168.0.0/16.)
4. Select Add.
5. Select Save.
Entering Allowed TCP and UDP Ports
1. Go to Settings , then Whitelist/Blacklist.
2. Select the textbox below either TCP Port (allow) or UDP Port (allow).
3. Enter the port number(s).
Note: Separate port numbers with a comma (,). For example: 53,67,68,137.
Note: Use a colon (:) to enter a range of ports. For example, 47814:47819.
4. Select Save.
KMC Commander Software Application Guide
33
AG231019E
Configuring IP Tables
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site. The IP Tables list is a master override whitelist of the LAN/WAN lists for Cloud connectivity.
Caution: Deleting any of the default listings is not recommended. Deleting the wrong listing could result in loss of communication with the gateway.
Adding to IP Tables
1. Go to Settings , then IP Tables.
2. In IP Address, TCP Ports, and/or UDP Ports, enter the relevant IP address and connected ports as needed.
Note: Enter an address or a range with the range defined with the subnet mask length using CIDR (Classless Inter-Domain Routing) notation. (For example, enter the base address, followed by a slash, and then the subnet mask length as the number of most significant bits of the IP address, such as 192.168.0.0/16.)
3. Select Save.
Configuring Proxy Settings
For increased security, you can only configure these settings when logged into the gateway locally. See Logging In at the Job Site. If required for this KMC Commander gateway:
1. Go to Settings , then Proxy.
2. Enter the HTTP Proxy Address and the HTTPS Proxy Address.
3. Select Save.
Configuring SSH Settings
For increased security, you can only enable SSH when logged into the gateway locally. See Logging In at the Job Site. KMC Commander’s remote SSH (Secure SHell) login access is primarily for technical support representatives using a terminal emulator to provide troubleshooting or system configuration. For security, remote terminal access is disabled by default. Only when remote terminal access is needed:
1. Go to Settings , then SSH. 2. Switch Disabled to Enabled.
KMC Commander Software Application Guide
34
AG231019E
Configuring Networks
Supported Network Protocols
KMC Commander can connect to these protocols: l BACnet IP (directly) l BACnet Ethernet (directly) l BACnet MS/TP (with a BAC-5051AE BACnet Router) l KMDigital (with a KMD-5551E Translator or a KMDigital controller with a BACnet Ethernet interface) l Modbus TCP (directly, with an imported Modbus register map CSV file) l SNMP (directly, with an imported MIB file) l Node-RED (with an additional license, installation of Node-RED, and custom programming).
Configuring a BACnet Network
Before Configuring a BACnet MS/TP Network
BACnet devices on an MS/TP network require a BAC-5051AE BACnet router for (IP or Ethernet) connection to the KMC Commander IoT gateway. See BAC-5051AE instructions for connecting MS/ TP devices to a KMC Commander network.
Note: The KMC Commander IoT gateway is not a BACnet router or a BACnet device. (Nevertheless, a 4194303 Device ID with “SimpleClient” may appear in the Network Manager of KMC Connect or TotalControl.)
Configuring a BACnet Network
1. Go to Networks Explorer , then Networks. 2. Select Configure New Network to go to the Configure Network page. 3. For Protocol, select BACnet. 4. For Data Layer, choose IP or Ethernet. 5. Enter the network name and address information.
Note: Network information is dependent on the site survey and the building’s IT.
Note: Be sure that port and network numbers are correct. Multiple networks may be required to see all devices. If BACnet devices are on the local network, do not enter the router’s IP address.
6. Optionally, choose Single or Range for Instance Filter Option.
KMC Commander Software Application Guide
35
AG231019E
Note: Entering a known range of device instances will speed up the later discovery process. If devices are not found as expected, try expanding the range or choose Any.
7. Select Save.
Continue by Configuring Devices on page 41.
Configuring a KMDigital Network
Know Before Beginning
KMC Commander can discover points within KMDigital controllers (depending on the controller models and network configurations):
l Using Tier 1 KMDigital controllers with BACnet Ethernet interfaces. (Only Tier 1 points are available–not points of connected Tier 2 controllers. No KMD-5551E Translator or Niagara network is required.)
l Using an existing KMC KMD-5551E Translator on a properly licensed Niagara network. (Tier 1 and 2 points are available.)
l Using a KMD-5551E Translator and a Translator license for KMC Commander. (Tier 1 and 2 points are available. No Niagara network is required.)
Note: Only KMDigital points and their values are available through the KMD-5551E Translator. KMDigital trends, alarms, and schedules are not available.
Note: See the KMD-5551E Translator documentation for instructions on how to install and use it on a KMDigital network.
Four Tier 1 KMDigital controller models have BACnet Ethernet interfaces. Their points are discoverable in KMC Commander as virtual BACnet objects using BACnet Ethernet protocol (without a KMD-5551E Translator or Niagara). (Points in any Tier 2 controllers connected to them by EIA-485 wiring, however, are not discoverable without a KMD-5551E.) The Tier 1 models with BACnet interfaces are:
l KMD-5270-001 WebLite Controller (discontinued)
l KMD-5210-001 LAN Controller (discontinued)
l KMD-5205-006 LanLite Controller (discontinued)
l KMD-5290E LAN Controller
Other KMC KMDigital devices can be discovered as virtual BACnet devices using a KMD-5551E Translator. Through an existing KMD-5551E Translator on a properly licensed Niagara network, points on KMDigital (Tier 1 and 2) controllers will appear as virtual BACnet objects. They are discoverable like regular BACnet objects. See Configuring a BACnet Network on page 35.
KMC Commander Software Application Guide
36
AG231019E
Without Niagara, a license to use the KMD-5551E with KMC Commander must be purchased from KMC Controls. (A KMD-5551E license for Niagara will not work as a license for the KMC Commander IoT gateway.)
Discovering KMDigital devices through a KMD-5551E without Niagara
1. Go to Networks Explorer , then Networks. 2. Select Configure New Network to go to the Configure Network page. 3. For Protocol, select BACnet. 4. For Data Layer, choose IP or Ethernet as needed (see above). 5. Enter the network Name and address information.
Note: Network information is dependent on the site survey and the building’s IT.
6. Optionally, choose Single or Range for Instance Filter Option.
Note: Entering a known range of device instances will speed up the later discovery process. If devices are not found as expected, try expanding the range or choose Any.
7. Select Save. Continue with Configuring Devices on page 41.
Note: Tier 1 KMDigital controller models with BACnet Ethernet interfaces have points discoverable as virtual BACnet objects using BACnet Ethernet protocol (without a KMD-5551E Translator or Niagara), but they do not fully support BACnet priority arrays. (The priority array does not display properly with these devices.) On a dashboard, clearing a selected priority 18 value now relinquishes to the previous scheduled (highest level priority 0 or 916) value that was last written.
Note: In those three Tier 1 KMDigital controller models (see above), any value written at a priority 0 or 916 is assumed to be a scheduled write and stored locally. Any value written at a priority 18 is assumed to be a manual write (which sets the manual flag on these devices). When relinquishing a priority 18 (by selecting Clear Selected under Show Advanced), the last scheduled write value is written and the manual flag is removed.
Note: The KMD-5551E KMDigital to BACnet Translator fully supports priority arrays in Tier 1 and Tier 2 devices.
Configuring a Modbus Network
Unlike BACnet, only one Modbus TCP device is added to the “network” during discovery according to the device information entered. For multiple Modbus devices, create multiple Modbus “networks.”
1. Go to Networks Explorer , then Networks. 2. Select Configure New Network to go to the Configure Network page.
KMC Commander Software Application Guide
37
AG231019E
3. For Protocol, select Modbus. 4. Enter the relevant network information in the fields. 5. Upload the Modbus register map CSV file for the particular Modbus TCP device:
A. Next to Map File, select Upload. B. Select Choose file. C. Locate the map file on your computer. D. Select Upload.
Note: For full instructions about the Modbus TCP device options as well as sample register map CSV files, see the Modbus Devices on KMC Commander Application Guide (see Accessing Other Documents on page 159).
6. Choose the Network Interface from the dropdown list. 7. Select Save. Continue with Configuring Devices on page 41.
Configuring an SNMP Network
About SNMP “Networks”
In an SNMP network, KMC Commander acts as an SNMP manager, gathering data points from agents (software modules inside devices such as routers, data servers, workstations, printers, and other IT devices) and triggering actions.
Note: Unlike BACnet, only one SNMP device is added to the “network” during discovery according to the information entered. For multiple SNMP devices, create multiple SNMP “networks.” For example, if the devices are all the same (e.g., four routers of the same model), the MIB file would be the same, but the IP address would be different for each one and would require four different “networks.”
Configuring
1. In Settings > Protocols, upload the manufacturer’s MIB file for the desired device. (See SNMP MIB Files on page 17 in Configuring Protocol Settings on page 13.)
Note: MIB (Management Information [data]Base) files contain data points describing the parameters of a particular device. The MIB file should be provided by the device manufacturer, and the file is uploaded to the manager (KMC Commander) so that the manager can decipher received data from the device.
2. Go to Networks Explorer , then Networks. 3. Select Configure New Network to go to the Configure Network page. 4. For Protocol, select SNMP.
KMC Commander Software Application Guide
38
AG231019E
5. Choose the SNMP Protocol Version used: l v1 (simplest, oldest, and least secure). l v2c (has additional features and the largest installed base) l v3 (most secure, the current standard, and recommended for use whenever possible)
6. Enter the network’s Name. 7. Enter the Device IP Address. 8. Optionally, enter any Subtree(s). 9. Enter the number for the Destination Port and Trap (notifications) Port if needed. (See the device’s
instructions.)
Note: The Destination Port (default 161) is the port in the SNMP agent (the device) that receives requests from the manager. The Trap Port (default 162) is the port in the manager (KMC Commander) that receives unsolicited notifications from the agents.
10. Select and enter user and security information as needed.
Note: Security settings are typically found in the SNMP device’s documentation or web management page. Use the highest security supported by the device (Auth Priv being the highest, with required authentication of users and encryption of messages). If the device documentation specifies only one read or one write password but supports v3 Auth Priv, try using the same password for both Auth and Privacy fields. If there is trouble connecting to a v3 device, and the documentation does not specify an Auth or Priv protocol, try switching one or both of those protocols.
11. Select Save. 12. Continue with Configuring Devices on page 41.
Configuring a Node-RED Network
About Node-RED “Networks”
Node-RED supports specific IP devices with programs developed by KMC Controls.
Note: Unlike BACnet, only one device is added to a Node-RED “network” during discovery, according to the device information entered. For multiple devices, create multiple Node-RED “networks”.
Before Configuring
Using Node-RED for discovery of devices requires installation of Node-RED, an additional license, and custom programming.
KMC Commander Software Application Guide
39
AG231019E
Note: Configuration can also be done through a licensed Node-RED add-on. See the KMC Commander Node-RED Application Guide (see Accessing Other Documents on page 159).
Configuring
1. Go to Networks Explorer , then Networks. 2. Select Configure New Network. 3. From the Protocol drop-down menu, select Node-Red. 4. Enter the device name and address information. 5. Enter the device Password. 6. Choose the Device Protocol (Shelly or WiFi_RIB) from the dropdown list.
Note: Leaving Default selected does nothing.
7. If you are configuring a relay that is bound to a Binary Input, select Relay Bound to BI. 8. Note: For Shelly device protocol, Relay Bound to BI is always selected by default, because Shelly devices
are always bound to a Binary Input.
9. Select Save. 10. Continue with Configuring Devices on page 41.
KMC Commander Software Application Guide
40
AG231019E
Configuring Devices
Discovering Devices
While devices can be discovered remotely from the Cloud, being on site is useful for troubleshooting. To discover devices, after Configuring Networks on page 35:
1. Select Discover. 2. Optionally, in Confirm Discover Options, change the Instance Min and Instance Max.
Note: Narrowing device discovery to a range of known device instances speeds up the discovery process.
3. Select Discover.
Note: For each device KMC Commander discovers, a row will appear with the device’s Instance ID.
Note: Select anywhere in a device row’s area to expand it to see more basic information about the device.
4. Select Get Device Details in a device’s row to get the remaining information about the device.
Note: Alternatively, select Get All Device Details to get the details for all discovered devices.
Continue by Assigning Device Profiles on page 41 to each device that is to be included in the KMC Commander installation.
Assigning Device Profiles
This topic describes the process for initially assigning device profiles immediately after Discovering Devices on page 41. For guidance on later changing a device’s profile, see Editing a Device Profile on page 43. Each device to be included in the KMC Commander installation must have a profile. Not all discovered devices need to be included, however. Assign profiles only for devices of interest. Points of interest count as points used out of the number licensed for the project. However, trends on the points of interest do not count toward the license limit.
Note: The total number of Points Used out of the number licensed for the project is shown in the upper-right corner of Networks Explorer.
While device profiles can be assigned remotely from the Cloud, being on site can be useful for troubleshooting.
Accessing the Assign profile Page
After Discovering Devices on page 41: 1. Select Save Device in the row of a device of interest.
Note: You must select Get Device Details or Get All Device Details first to see Save Device. (See Discovering Devices on page 41.)
KMC Commander Software Application Guide
41
AG231019E
2. Select Assign Profile to go to the Assign profile to [device name] page. If a profile with all points properly configured for a device already exists in the project, continue to Assigning an Existing Device Profile on page 43. Otherwise, continue to Creating and Assigning a New Device Profile on page 42 or Assigning a Device Profile Based on an Existing Profile on page 43.
Creating and Assigning a New Device Profile
1. From the Assign profile to [device name] page, select Create New.
2. Enter a Name for the device profile.
3. Select the Device Type from the drop-down menu.
4. From the Point Naming drop-down menu, choose either Protocol Default or Description.
Note: This choice affects what will appear in the Name column when the device’s points are discovered. This is primarily for KMDigital via BACnet Ethernet applications (see Configuring a KMDigital Network on page 36). If Description is selected during point discovery, the point name shown on dashboard cards will be the (KMDigital via BACnet Ethernet) controller point’s Description (for example, MTG ROOM TEMP) rather than the generic name (for example, AI4).
5. Select Discover.
6. For each point that you will track, trend, schedule and/or alarm:
a. Select Select Type to open the Select Point Type window.
Note: Choosing the type applies the correct Haystack tags to the point and enables its use with cards, schedules, and alarms. It also automatically selects the checkbox in the Points of Interest column. To search for tags after configuration, see Using Data Explorer on page 136.
Note: The total number of Points Used out of the number licensed for the project is shown in the upper-right corner of Networks Explorer.
b. Find and choose the point type using the dropdown menu, search, or tree selector.
7. For any points to be trended, also select their checkboxes in the Trend (his) column.
8. Optionally, select an individualized trending frequency for some points from the Trending Frequency dropdown menu.
Note: The values for the Low, Medium, and High options are configured in Settings > Protocols > Individual Point Intervals. See the topic on Individual Point Intervals on page 13 for more information.
9. After all points of interest are configured, select Save & Assign Profile.
KMC Commander Software Application Guide
42
AG231019E
Assigning an Existing Device Profile
Caution: For multiple devices using the same profile, after saving one device, wait at least three minutes before saving the profile for the next device. (This ensures that all necessary writes are made and ensures the reliability of the data and the profile.)
1. From the Assign profile to [device name] page, select Select Existing Profile. 2. Choose which Profiles to show: Global only, or Project Only. 3. Choose the profile from the dropdown list. 4. Select Assign Profile.
Assigning a Device Profile Based on an Existing Profile
1. From the Assign profile to [device name] page, select Select Existing Profile. 2. Choose which Profiles to show: Global only, or Project Only. 3. Choose the existing profile you want to use as the basis for a new profile from the dropdown list. 4. Make any necessary changes to the profile. 5. Select Save Copy & Assign. 6. Enter a name for the new profile. 7. Select Assign & Save.
Editing a Device Profile
See also information on the related but separate process, Editing Device Details on page 44. 1. Go to Networks Explorer , then Networks. 2. Select View (in the row of the network that has the device with the profile that you want to edit). 3. Select Edit Profile (in the row of the device with the profile that you want to edit). 4. Take any of the following actions to edit the profile: l Edit the Name. l Change the Device Type. l Add points of interest: a. Select Select Type (in the row of a point you want to add), which opens the Select Point Type window. b. Find and choose the point type using the dropdown menu, search, or tree selector.
KMC Commander Software Application Guide
43
AG231019E
Note: Choosing the type applies the correct Haystack tags to the point and enables its use with cards, schedules, and alarms. It also automatically selects the checkbox in the Points of Interest column. To search for tags after configuration, see Using Data Explorer on page 136.
Note: The total number of Points Used out of the number licensed for the project is shown in the upper-right corner of Networks Explorer.
c. For all points that are to be trended, also select their checkboxes in the Trend (his) column.
5. Select Update Profile & Assign.
Note: A list of all the devices that use this profile appears in an Assign profile window.
6. Select the checkboxes next to the devices that you want to assign this edited profile to. 7. Select Assign to Devices.
Note: Regenerating Points will appear at the bottom and will revert to an Assign Profile button when the process completes. It is okay to leave the page during the process. In the network’s device list, a spinning gear icon will appear under Actions until the device profile has regenerated.
Editing Device Details
1. Go to Networks Explorer . 2. Select view network from the row of the network that the device belongs to. 3. Select Edit Device (from the row of the device that you want to edit), which makes an Edit [Device Name]
Details window appear. 4. Edit the Device Name, Model Name, Vendor Name, and/or Description.
Note: If the device is a Modbus device, you can also set a Read/Write Delay (ms).
Note: Point Read Batch (Count) defines how many points to read at once during a single connection to a Modbus device. The default is 4. Increasing Point Read Batch (Count) decreases the amount of connections made to the Modbus device, which may prevent it from locking up. (If you set Point Read Batch (Count) to the amount of points needing read, the KMC Commander gateway will only make one connection to the device.) However, depending on the KMC Commander gateway’s connection speed, increasing Point Read Batch (Count) may cause it to time out.
5. Select Save. Note: Later selecting Refresh Device Details
for the device could cause the changes to be overwritten.
KMC Commander Software Application Guide
44
AG231019E
Creating a Site Topology
Note: In Settings > Users/Roles/Groups > Users, the site topology can be used to allow users to view and control some devices and not others. (See Adding and Configuring Users on page 18.)
Adding a New Node to the Site Topology
1. Go to Networks Explorer , then Site Explorer. 2. Select Add New Node, which opens the Add New Node window. 3. From the Type dropdown menu, choose whether the topology node is for a Site, Building, Floor, Zone, Virtual
Device, or Virtual Point.
Note: For Virtual Device details, see Creating a Virtual Device on page 45. For Virtual Point details, see Creating a Virtual Point on page 46.
4. Enter a Name for the node.
Note: You can edit the node’s name later by selecting it, then selecting Edit.
5. Select Add. 6. Drag and drop items to reflect the site’s hierarchy.
Note: Devices can be dragged directly under a new building, floor, or zone. Zones are under floors, floors are under buildings, and buildings are under sites. A green check mark (instead of a red NO symbol) appears when dragging items onto possible locations.
Editing a Node’s Properties (Area)
1. Go to Networks Explorer , then Site Explorer. 2. Select the node, then select Edit Properties (which appears on the node’s right) to open the Edit [Node Type]
Properties window. 3. Select the Unit of Measure dropdown menu, then choose Square Feet or Square Meters. 4. Enter the Area of the space represented by the node. 5. Select Save.
Creating a Virtual Device
A virtual device can contain a selection of points copied from a physical device. This is helpful if a device has many points (such as a JACE), but you want to monitor closely and/or control only a portion of them.
1. Go to Networks Explorer , then Site Explorer. 2. Select Add New Node to open the Add New Node window.
KMC Commander Software Application Guide
45
AG231019E
3. From the Type dropdown menu, select Virtual Device. 4. From the Select Device dropdown list, select the physical device that you want to copy points from for your
virtual device. Note: You can narrow the list of devices to choose from by typing in the dropdown list selector.
5. Select the checkboxes next to the points you want to copy to your virtual device. 6. Enter a Name for the virtual device. 7. Select Add.
Note: You may need to scroll down to see the Add button.
Creating a Virtual Point
Note: Virtual points are an advanced feature requiring knowledge of JavaScript. See Virtual Point Program Examples on page 46. 1. Go to Networks Explorer , then Site Explorer. 2. Select Add New Node to open the Add New Node window. 3. From the Type dropdown menu, select Virtual Device. 4. From the Select Device dropdown list, select the device.
Note: You can narrow the list of devices to choose from by typing in the dropdown list selector.
5. From the Select Point dropdown list, select the point. Note: You can narrow the list of points to choose from by typing in the dropdown list selector.
6. Edit the JavaScript program in the text box. Note: For guidance, see Virtual Point Program Examples on page 46.
7. Enter a Name for the virtual point. 8. Select Add.
Virtual Point Program Examples
About Virtual Points
Virtual points enable building of complex logic on top of existing points in the system without the creation of additional points or complex control code on devices. A simple JavaScript function is executed on each update of the source point(s) and can produce one or more outputs for the virtual point. Virtual points are ideal for unit
KMC Commander Software Application Guide
46
AG231019E
conversion, computing periodic averages or sums, or for running more advanced application-specific logic.
function run(device, point, latest, state, emit, toolkit){ /*
device */ }
Term from JavaScript program
Description
function run ( )
Takes in arguments (for example: point, device, etc.) and executes them each time the point is updated.
A JSON object that has properties, such as point.tags, which reflect Project Haystack. Examples:
l point.tags.curVal (the current value)
l point.tags.his (a boolean indicating whether or
point
not the point is trended).
Note: Examine the point object’s available properties using Using Data Explorer on page 136.
device latest
Every point is associated with a device. The device scope is a JSON object that contains relevant tag values.
Note: For the data structure, please search for the device in Using Data Explorer on page 136.
A JSON object with the following keys: l v: (the current value of the point, otherwise referred to as curVal)
l t: (timestamp)
Allows you to add to the trend value. You can pass the
following:
l v: (the current value of the point, otherwise
emit
referred to as curVal)
l t: (timestamp)
KMC Commander Software Application Guide
47
AG231019E
Term from JavaScript program
Description
state toolkit
An empty JSON object that can be used to save information.
A set of JavaScript libraries, including: l Moment (a data and time utility library)
l Lodash (a modern JavaScript utility library delivering modularity, performance, and extras)
Examples
Estimating Power
function run(device,point, latest, state, emit, toolkit){ emit({
t: latest.t, v: latest.v*115 }) }
The first line contains variables coming into the function. For instance, latest is a variable containing the current time and value of the source point. The second line emits variables out of the function. latest.v is the value read from the real point. v is the value you want the virtual point to be. This example is creating a rough estimate of power. The real point is measuring current. The virtual point will be 115 times the current reading. The time is t. The emit argument is a JSON object, which is a way of expressing name:value pairs. You can separate each pair onto its own line. Each name:value pair is separated by a comma. The colon (:) is similar to an equal sign, so the name t is being set to latest.t. The value will typically be a calculation.
Binary Virtual Point to Indicate an Analog Point is Too High
function run(device,point, latest, state, emit, toolkit){ emit({
t:latest.t, v: latest.v > 80 }) }
KMC Commander Software Application Guide
48
AG231019E
Continuous Sum (Sigma)
The sigma function sums all the values over time. Here we use state to persist sum and add whenever a point is updated.
function run(device, point, latest, state, emit, toolkit){ // Compute the continuity of all current values (Sigma Function) var sigma = 0;
if(state.sigma){ sigma = state.sigma; }
sigma+= latest.v;
emit({ v: sigma, t: toolkit.moment().valueOf() });
}
Fahrenheit to Celsius
Here is a run function that applies the Fahrenheit to Celsius formula to the latest value:
function run(device, point, latest, state, emit, toolkit){ // Get the latest.v point in Fahrenheit and convert to Celsius; var c = (latest.v – 32) * (5/9); emit({
v: c, t: toolkit.moment().valueOf() }); }
Celsius to Fahrenheit
Here is a run function that applies the Celsius to Fahrenheit formula to the latest value:
function run(device, point, latest, state, emit, toolkit){ // Get the latest point in Celsius and convert to Fahrenheit; var f = (latest.v *(9/5)) + 32; emit({
v: f, t: toolkit.moment().valueOf() }); }
KMC Commander Software Application Guide
49
AG231019E
Weekly Average
Here is a run function that computes the average of the values updated for a week (Sunday-Saturday):
function run(device,point, latest, state, emit, toolkit){ // average if(state.sum == null) state.sum = 0; if(state.num == null) state.num = 0; if(state.t == null) state.t = toolkit.moment(new Date()).startOf(‘week’); state.num++; state.sum += latest.v; // only emit once we’ve passed the end of a day if(toolkit.moment(latest.t).startOf(‘week’)!=toolkit.moment
(state.t).startOf(‘week’)){ emit({t: toolkit.moment(state.t).endOf(‘day’), v: state.sum/state.num}); state.t = null; state.num = null; state.sum = null; }
}
Finding and Deleting Orphan Nodes
Sometimes in the processes of adding or removing devices or points and creating cards, you end up with: l devices you are no longer using that have lost a network reference
l points you are no longer using that have lost a device reference
Collectively these devices and points are called orphan nodes. To find and delete orphan nodes:
1. Go to Networks , then Orphan Nodes.
2. From the option buttons, choose either Devices or Points.
3. Select all orphaned nodes using the select all checkbox, or select specific points that you want to delete.
4. Select Delete Nodes.
Note: The nodes will delete immediately. No confirmation is required.
KMC Commander Software Application Guide
50
AG231019E
Dashboards and Their Elements
About
Dashboards can hold cards, decks, canvases, and report modules. The initial home screen will be blank before adding a dashboard. Once you add a dashboard, you can add instances of cards, decks, and canvases.
Cards are the primary means to visualize network data and control equipment from a web browser. Cards allow users to change setpoints and view equipment point values. To be able to command a point from a card, the point must be made commandable (under the Type column) in the device profile (for example, Analog > Command). You do not have to configure points you don’t want to use.
Decks are an optional method of organizing the cards (such as the most critical cards or all the cards related to a particular floor). Decks can show a carousel of the included cards.
Canvases are creative spaces to arrange points and/or zone shapes (both with customizable colors and opacity) on a background image uploaded from your computer. Displaying live point values on equipment graphics and floor plans are typical uses.
After configuring report settings in Reports , you can add an instance of a report module or a report card to a (non-global) dashboard to display the report.
Dashboards and their elements are specific to user logins. Decks added by a system administrator or technician for a site will be available to add to the dashboard of that customer. This is a convenient way for a customer to create their own dashboard without needing to create each card from scratch.
In the KMC license server, KMC can also add a customer image URL to the license. The logo or other image will then display to the left of the project name on the dashboard. (To use this feature, supply KMC Controls with the image’s URL address.)
Adding and Configuring Dashboards
Adding a New Dashboard
1. Select Dashboards , which opens the dashboard selector sidebar.
2. Select one of the options (at the bottom of the dashboard selector): l Add Dashboard — creates a standard dashboard, on which you can display information only from the project that the dashboard belongs to.
l Add Global Dashboard — creates a global dashboard, on which you can display information from any project that you have access to, not just from the project to which the global dashboard belongs. The dashboard will have globe icon to indicate that it is a global dashboard.
Caution: Currently, point override display and default write values will use the current project’s settings rather than the individual projects’ settings. (See Display Point Override
KMC Commander Software Application Guide
51
AG231019E
on page 10, Default Manual Write Priority on page 15, and Manual Write Timeout on page 15.) If individual projects’ settings differ, take care when making point override changes or interpreting an override warning on a global dashboard.
Note: A dashboard preview named “New Dashboard” appears in the dashboard selector and the new, empty dashboard displays in the viewing window. See Renaming a Dashboard on page 55 for how to change the name.
Setting a Dashboard Preview Image
1. Go to the dashboard that you want to set the preview image for. 2. Select the gear icon (next to the dashboard’s name), which makes the dashboard settings menu appear. 3. Select Set Preview Image.
Note: An Upload For [dashboard name] window appears.
4. Select Choose file.
5. Find and open the image file from your computer that you want to be the preview image.
Note: The recommended image dimensions are 550px by 300px. It must be less than 5 MB. An image optimized to the smallest file size possible (without losing the quality needed) is recommended. Accepted file types are .png, .jpeg, and .gif.
6. Select Upload.
Setting a Dashboard’s Width
When a dashboard is added, its width is the Fixed Dashboard Width on page 10 set in Settings Settings.
> Project
Note: Hover over the columns icon to find out the number of columns Fixed Dashboard Width is set to. If no columns icon, Fixed Dashboard Width is set to Auto (i.e. a responsive layout).
You can also individually set a dashboard’s width. For that dashboard the individual setting will override the projectwide setting. To set a Dashboard Width:
1. On the dashboard that you want to set the width for, select Configure Dashboard .
2. Select Dashboard Width, which opens a Set Dashboard Width window.
3. From the dropdown menu, select the desired number of columns, or enter the number.
Note: A column is the width of one medium-sized card (for example, one Weather card).
4. Select Save.
KMC Commander Software Application Guide
52
AG231019E
Note: Hovering over the columns icon will show the number of columns set.
Note: A left-right scroll bar will appear on narrower screens and browser windows.
Changing the Dashboard Refresh Interval
To change the Refresh Interval at which elements on all dashboards are updated with Cloud data: 1. With a dashboard displayed, select Configure Dashboard . 2. Select Refresh Interval, which makes the Set Refresh Time window appear. 3. Select the desired interval from the drop-down menu.
Note: Refresh Interval is the interval at which dashboards fetch data from the Cloud. It does not change the interval at which devices are polled for data, which is set in Settings > Protocols > Point Update Wait Interval (Minutes) on page 15.
4. Select Save.
Setting a Dashboard as the Homepage
When a dashboard is set as the homepage, it is the first dashboard that appears after logging in. 1. Go to the dashboard that you want to make the homepage. 2. Select the gear icon . 3. Select Set as homepage.
Selecting a Dashboard to View
1. Select Dashboards , which makes the dashboard selector sidebar appear. Note: For users with Admin permissions (see Configuring Roles on page 23 ), there is a switch at the top of the selector. Toggle the switch to either Showing only your dashboards or Showing all dashboards (for the project).
2. Select the name or preview of the dashboard that you want to view.
Note: The dashboard appears in the viewing area to the right.
Making a Copy of a Dashboard
1. Go to the dashboard that you want to make a copy of. 2. Select the gear icon . 3. Select Make a copy.
KMC Commander Software Application Guide
53
AG231019E
Note: The copy is made and is displayed in the viewing area. The copy has the same name as the original plus a number in parenthesis at its end. See Renaming a Dashboard on page 55 for how to change the name.
Sharing Dashboards
1. With the dashboard that you want to share displayed in the viewing window, hover over the dashboard’s name.
2. Select the gear icon that appears.
3. Select Share, which opens the Share dashboard window.
Note: You can select other dashboards to share besides the one currently displayed by choosing them from the Select dashboard dropdown list.
4. Select the checkboxes of the Users to whom you want to give Read-only access, Write Access, or Share a Copy of the dashboard.
Note: See Types of Sharing on page 54 for details of each option.
5. Select Submit.
Types of Sharing
Read-only
Read-only access allows the other users to see the dashboard, but not modify cards or decks. Any changes made to the dashboard from your account can be seen automatically by the other users from their accounts. From your account, a group icon will show next to the name of the dashboard. Hovering a cursor over the icon displays a message stating the number of users with whom the dashboard is shared. From the other users’ accounts, an eye icon will show next to the name of the dashboard, indicating it is read-only.
Note: While other users will not be able to modify the dashboard’s cards, setpoints on those cards may still be editable depending on a user’s role.
Write Access
Write Access allows the other users to both see and edit the dashboard. Any changes made to the dashboard from your account can be seen by the other users from their accounts. Likewise, any changes made to the dashboard from the other user’s accounts can be seen from your account. A group icon will show next to the name of the dashboard when viewed from all users’ accounts. Hovering a cursor over the icon displays a message stating the number of users with whom the dashboard is shared.
Note: It is advised that not more than one user customize a card at the same time. If multiple users are in a card’s customize mode at once, the user who exits customize mode last (by clicking the pencil icon) will overwrite the other user(s) changes.
KMC Commander Software Application Guide
54
AG231019E
Share Copy Share Copy makes “snapshot” copies of the dashboard as it is currently set up and shares those copies with the other users, which they can then customize as needed. The original dashboard and its copies are not connected in any way. Any subsequent changes you make to the original dashboard will not be reflected in the copies shared with the other users. Likewise, any subsequent changes that the other users make to their copies will not be reflected elsewhere.
Modifying (and Deleting) Dashboards
Renaming a Dashboard
A dashboard can be renamed from either the dashboard selector or when it is displayed in the viewing window. From the Dashboard Selector
1. If the dashboard selector is not already open, select Dashboards to open it. 2. Select the gear icon in the dashboard preview of the dashboard you want to rename. 3. Select Rename.
From the Viewing Window 1. Go to the dashboard that you want to rename. 2. Select the gear icon . 3. Select Rename from the menu that appears. 4. Enter a new Dashboard name. 5. Select Submit.
Rearranging Cards and Decks on a Dashboard
1. In Dashboards , select Edit Layout (in the upper-right of corner of the dashboard).
Note: This causes the grip icon to appear in the upper-right corner of cards and decks.
2. Grab (select and hold) a card or deck that you want to move by its grip . 3. Drag the card or deck over to where you would like it to be.
Note: The other cards automatically rearrange to make room for the card.
4. Drop the card or deck in its new location. 5. Keep rearranging cards and decks until the layout is the way you would like it. 6. Select Save Layout.
KMC Commander Software Application Guide
55
AG231019E
Deleting a Dashboard
1. Go to the dashboard that you want to delete. 2. Select the gear icon . 3. Select Delete. 4. Select (Confirm Delete).
Creating and Adding Cards
For maximum performance, if the desired number of cards (depending on complexity) exceeds 12, make multiple dashboards with fewer cards on each dashboard. For example, make several dashboards for system-level views and other dashboards for equipment-level details.
Creating a Custom Card
About Custom Cards
If one of the standard card types does not meet the application need, you can create a simple Custom card, which shows values in up to 10 slots.
Creating the Custom Card
Access the Custom Card Staging Area 1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select Custom card (if not already selected) from the card type options at the left.
Select Points For each slot that you want to fill with a point:
1. Select Select Point, which makes the Device list and Point Selector appear.
Note: The Point Slot tab is selected by default.
2. Locate and choose the point.
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
KMC Commander Software Application Guide
56
AG231019E
Note: Below a device name, the information in gray text is the device type, as set in the device’s profile (see Editing a Device Profile on page 43). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
Add Text Slots (Optional) 1. Select Select Point. Note: The Device and Point Selector appear, because the Point Slot tab is selected by default.
2. Select Text Slot, which switches to a text editor tab. 3. Type and format text and/or hyper-linked text, as you would in a simple word processor. 4. Select Save. Title and Size 1. Enter a Card title. 2. Choose a default Size Type from the dropdown menu. Add to the Dashboard 1. Select Add. 2. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Creating a KPI Card
About KPI Cards
KPI (Key Performance Indicator) cards are smaller than other cards and can track a point in a particular device or track a metric. Metrics are, for example, the BTU rate or electric power for an entire floor, zone, building, or site, based on the topology set up in Network Explorer > Site Explorer. KPI metrics are based on area. Edit
KMC Commander Software Application Guide
57
AG231019E
Properties in Site Explorer provides fields to enter area values and units (see Editing a Node’s Properties (Area) on page 45).
Creating the KPI Card
Access the KPI Card Staging Area 1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select KPI card from the card type options at the left.
Select a Point 1. Select +, which makes the Device list and Point Selector appear. 2. Locate and choose the point.
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
Note: Below a device name, the information in gray text is the device type, as set in the device’s profile (see Editing a Device Profile on page 43). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
Add Status Colors See Adding Status Colors on page 59 for details. Add Text Slots (Optional)
1. Select Select Point. Note: The Device and Point Selector appear, because the Point Slot tab is selected by default.
KMC Commander Software Application Guide
58
AG231019E
2. Select Text Slot, which switches to a text editor tab. 3. Type and format text and/or hyper-linked text, as you would in a simple word processor. 4. Select Save.
Title and Size 1. Enter a Card title. 2. Choose a default Size Type from the dropdown menu.
Add to the Dashboard 1. Select Add. 2. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Adding Status Colors
When status colors are configured, a color-coded status bar displays on the left edge of the card’s point slot. You can configure the status color to change depending on point’s current value. Using Premade Color Sets
1. Select Add colors (on the point slot’s left), which makes a window appear. 2. Choose a Color Set from the dropdown menu. 3. Enter the Min value and Max value.
Note: See the preview of the color spectrum that will be applied to the entered range of values.
4. If you want this color configuration to apply to the text as well, select the Apply color to text checkbox. 5. Select Save to apply the status color configuration to the point.
Using a Custom Color Set 1. Select Add colors (on the point slot’s left), which makes a window appear. 2. From the Color Set dropdown menu, select Custom. 3. Enter the Min value and Max value. Note: To add intermediate values, select the + (Add intermediate value). Then enter the new Intermediate value.
4. Select the thumbnails below the color spectrum, which opens a color palette. 5. Do one of the following to choose a color:
l Use the color slider and move the selection circle.
KMC Commander Software Application Guide
59
AG231019E
l Enter the HEX color code. l Select a previously used color and opacity setting from the rectangular swatches at the bottom of the
palette.
6. Do one of the following to change the opacity: l Use the opacity slider. l Change the seventh and eighth digits of the HEX code. l Select a previously used color and opacity setting from the rectangular swatches at the bottom of the palette.
7. If you want this color configuration to apply to the text as well, select the Apply color to text checkbox. 8. Select Close.
Note: See the preview of the color spectrum that will be applied to the entered range of values.
9. Select Save to apply the status color configuration to the point.
Creating a KPI Gauge Card
About KPI Gauge Cards
KPI (Key Performance Indicator) gauge cards are smaller than other cards and track a point in a particular device or track a metric. KPI gauge cards display a number (like KPI cards), plus an animated gauge graphic. Metrics are, for example, the BTU rate or electric power for an entire floor, zone, building, or site, based on the topology set up in Network Explorer’s Site Explorer. KPI metrics are based on area. Fields to enter area values and units are found within Networks Explorer > Site Explorer. See Editing a Node’s Properties (Area) on page 45 for details.
Creating the KPI Gauge Card
Access the KPI Gauge Card Staging Area 1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select KPI gauge from the card type options at the left.
Select a Point 1. Select Select Point, which makes the Device list and Point Selector appear. 2. Locate and choose the point.
KMC Commander Software Application Guide
60
AG231019E
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
Note: Below a device name, the information in gray text is the device type, as set in the device’s profile (see Editing a Device Profile on page 43). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
Configure the Gauge 1. Choose a Color Range for the gauge. Note: Default is a white to orange gradient.
2. Choose the Gauge Type: Gauge or Gauge with Needle. 3. Enter the gauge’s:
l Min (minimum) value. l Lower Middle value (only for a gauge with a needle). l Upper Middle value (only for a gauge with a needle). l Max (maximum) value.
Title and Size 1. Enter a Card title. 2. Choose a default Size Type from the dropdown menu.
Add to the Dashboard 1. Select Add.
KMC Commander Software Application Guide
61
AG231019E
2. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Configuring the Area
Fields to enter area values and units are found within Networks Explorer Node’s Properties (Area) on page 45 for details.
> Site Explorer. See Editing a
Creating a Trend Card
About Trend Cards
Trend cards display point values over time on a graph. Graph information can be displayed by Day, Week, or Month. Slider bars below the graph allow zooming in on particular sections. Placing the cursor on the line shows information about that point at that time. The present values of points are shown in slots below the graph. Any commandable points (for example, a setpoint) can be written to using the card. When a trend card is sized to Wide, Large, or Extra Large, the data can be viewed in Realtime, or by Daily (Avg), Weekly (Avg), or Monthly (Avg).
Creating the Trend Card
Access the Trend Card Staging Area
1. With the dashboard that you want to add the card to displayed, select Add Instance.
2. Select Card, which opens the card staging area.
3. Select Trend from the card type options at the left.
Select Points
For each slot that you want to fill with a point: 1. Select Select Point, which makes the Device list and Point Selector appear.
Note: The Point Slot tab is selected by default.
2. Locate and choose the point.
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
Note: Below a device name, the information in gray text is the device type, as set in the device’s profile (see Editing a Device Profile on page 43). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
KMC Commander Software Application Guide
62
AG231019E
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
Add Text Slots (Optional) 1. Select Select Point. Note: The Device and Point Selector appear, because the Point Slot tab is selected by default.
2. Select Text Slot, which switches to a text editor tab. 3. Type and format text and/or hyper-linked text, as you would in a simple word processor. 4. Select Save.
Title and Size 1. Enter a Card title. 2. Choose a default Size Type from the dropdown menu.
Add to the Dashboard 1. Select Add. 2. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Creating a Thermostat Card
About Thermostat Cards
Thermostat cards display values, such as temperature, humidity, and CO2, as well provide control of setpoints and other commandable (writable) points. Selecting the heating setpoint, cooling setpoint, or a writable slot on the card allows changing of the value, with a specific write priority and timeout.
Creating the Thermostat Card
Access the Thermostat Card Staging Area 1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area.
KMC Commander Software Application Guide
63
AG231019E
3. Select Thermostat from the card type options at the left.
Select Points For each slot that you need configured:
Note: In most cases, the central slot, heating slot, and cooling slot should be configured.
1. Select the slot on the card preview (such as Select Point), which makes the Device list and Point Selector appear.
2. Locate and choose the point that corresponds to the type of slot selected.
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
Note: Below a device name, the information in gray text is the device type, as set in the device’s profile (see Editing a Device Profile on page 43). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
Add Text Slots (Optional) 1. Select Select Point. Note: The Device and Point Selector appear, because the Point Slot tab is selected by default.
2. Select Text Slot, which switches to a text editor tab. 3. Type and format text and/or hyper-linked text, as you would in a simple word processor. 4. Select Save.
Title and Size
1. Enter a Card title.
KMC Commander Software Application Guide
64
AG231019E
2. Choose a default Size Type from the dropdown menu. Add to the Dashboard
1. Select Add. 2. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Creating a Weather Card
About Weather Cards
Weather cards show the current outside air temperature, relative humidity, and weather conditions on their top half, and a four-day forecast on the bottom.
Before Beginning
In Settings > Weather: l Add weather stations. l Select the default units (Fahrenheit or Celsius) to display on weather cards.
Note: See Configuring Weather Settings on page 26 for details.
Creating the Card
1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select Weather from the card type options at the left. 4. Choose a Weather Station from the dropdown list.
Note: Initially, Card title is the same as Weather Station (the city’s name). However, you can change the card’s name directly from the dashboard later.
5. Select Add. 6. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Note: There is only one Size Type (Medium) for weather cards.
Creating a Web Card
About Web Cards
Web cards can display webpages. The webpage must be HTTPS with a public URL (no on-premise IPs), and the site must allow HTML Inline Frame (iframe) elements.
KMC Commander Software Application Guide
65
AG231019E
Applications include: l Documents l Live, cloud-based camera feeds
Note: This does not include local CCTV camera feeds.
l Node-RED dashboards l Videos
Note: For a video on YouTube, use the address within the iframe tag found within Share > Embed below the video (for example, https://www.youtube.com/embed/_f3ijEWDv8k). A URL taken directly from the YouTube browser window will not work.
l Weather radar l Webpages with forms for submission
Creating the Card
1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select Web from the card type options at the left. 4. Enter a Card title. 5. Choose a default Size Type from the dropdown menu. 6. Enter a valid Web URL.
Note: See About Web Cards on page 65 for guidance about valid URLs.
7. Select Validate URL.
Note: If the URL is valid, a notification that reads “[URL] can be embedded” will appear briefly. If it is invalid, the message will read, “Please make sure this is an https URL with a valid source, and the X-Frame-Options header is set to allow”.
8. Select Add. 9. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Creating a Text Editor Card
About Text Editor Cards
Text Editor cards allow you to compose and display text such as you would in a simple note app.
KMC Commander Software Application Guide
66
AG231019E
Examples of applications include displaying: l Links to PDF files. l Links to saved report settings (see Linking to a Report on page 130). l Equipment instructions. l Cautionary warnings. l User manuals. l Contact info.
Creating the Card
1. With the dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select Text Editor from the card type options at the left. 4. Enter a Card title. 5. Choose a default Size Type from the dropdown menu. 6. Compose text on the card.
Note: You can compose text on the card now, or directly from the dashboard later.
Note: See Composing Text on page 67 for details.
7. Select Add. 8. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Composing Text
Accessing the Card’s Edit Mode 1. Move over the space to the right of the card’s title. 2. Select the gear icon , which enables the card’s Edit Mode.
Typing, Formatting, and Saving Text 1. Type and format the text as you would in a simple word processor. 2. Close Edit Mode, which saves your changes.
KMC Commander Software Application Guide
67
AG231019E
Caution: Close Edit Mode before navigating away from the dashboard. Navigating away before closing Edit Mode discards any changes.
Creating Links to Web URLs 1. Highlight the text that you want to make into a hyperlink. 2. Select the link icon . 3. Copy and paste into Enter link the web URL that you want to link to. 4. Select Save. 5. Close Edit Mode, which saves your changes.
Caution: Close edit mode before navigating away from the dashboard. Navigating away before closing Edit Mode discards any changes.
Creating a Report Card
About Report Cards
After configuring a report setting in Reports , you can display the report on a (non-global) dashboard using a Report Card. Alternatively, you can add a Report module. (See Adding a Report Module on page 88.) Report modules can easily switch between report settings. However, unlike a Report Card, a Report module always spans the entire width of a dashboard.
Creating the Report Card
Access the Report Card Staging Area 1. With the (non-global) dashboard that you want to add the card to displayed, select Add Instance. 2. Select Card, which opens the card staging area. 3. Select Report Card from the card type options at the left.
Select a Report Setting From the Select Report dropdown list, select the setting of the report that you want to display.
Note: The listed report settings are configured in Reports . (See Managing Reports on page 119.)
Title and Size 1. Enter a Card title. 2. Choose a default Size Type from the dropdown menu.
KMC Commander Software Application Guide
68
AG231019E
Add to the Dashboard 1. Select Add. 2. Choose either Add to Top of Dashboard or Add to Bottom of Dashboard.
Duplicating a Card Across Devices
If several devices use the same profile, you can create a card for one of the devices, then automatically duplicate that card for the other devices.
1. Hover at the top edge of the device’s card that you want to duplicate for other devices. 2. Select the More icon on the toolbar that appears. 3. Select Duplicate Card.
Note: A list of all the other devices that share the same profile appears to the right.
Note: If no other devices also have this profile, a message will appear to the right. Assign this device’s profile to other devices. (See Assigning Device Profiles on page 41.)
Note: If this card contains more than one device’s points, it can not be automatically duplicated. Create each card manually. (See Creating and Adding Cards on page 56.)
4. Check the boxes next to the devices that you want to duplicate this card for. 5. Leave the Naming Convention as is, or modify it.
Note: <Device> will automatically insert each device’s name into its card title.
6. Select Duplicate. Note: The cards are automatically created and added to the bottom of the dashboard.
Modifying Cards
Editing a Card’s Title
1. Move over the space to the right of the card’s title. 2. Select the More icon on the toolbar that appears. 3. Select Rename Card. 4. Edit the Card Title as needed. 5. Select Submit.
KMC Commander Software Application Guide
69
AG231019E
Changing or Adding Points on a Card
1. On a card with configurable device points, hover near the upper-right corner, which causes a toolbar to appear. 2. Select the gear icon , which opens the card’s Edit Mode. 3. Select the point slot that you want to change, which makes a Device list and Point Selector appear. 4. Locate and choose the needed point.
Note: If creating on a global dashboard , a drop-down menu is above the Device list and Point Selector. If you want to select a point from a different project, select that project from the drop-down menu first.
Note: Below a device name, the information in gray text is the device type, as set in the device’s profile (see Editing a Device Profile on page 43). Below a point name, the information in gray text is [parent device name]:[point ID].
Note: Selecting a device from the Device list (left) narrows the Point Selector list (right) to show only the points in that device.
Note: You can filter both lists by typing in Search Devices. You can also filter the Point Selector list by typing in Search Points.
Note: As devices and points are filtered, the number of displayed devices or points out of the total (matching that criteria) is given at the bottom of each list.
Note: To display more devices or points in a list, select Load More Devices or Load More Points (at the bottom of each list).
5. Close Edit Mode.
Reconfiguring the Area, Range, and Color of a KPI Gauge Card
1. Move over the space to the right of the KPI gauge card’s title. 2. Select the More icon on the toolbar that appears. 3. Select Configure. 4. Modify the Area, Min, Max, and Color Range as needed. 5. Select Submit.
Changing the Weather Station Displayed by a Weather Card
1. Move over the space to the right of the Weather card’s title.
KMC Commander Software Application Guide
70
AG231019E
2. Select the More icon on the toolbar that appears. 3. Select Edit Weather Station, which causes a list to appear to the right. 4. Choose the weather station that you want the card to display.
Changing the Webpage Displayed by a Web Card
1. Move over the space to the right of the web card’s title. 2. Select the More icon on the toolbar that appears. 3. Select Set Web URL, which opens the Edit Web URL window. 4. Enter the Web URL that you want the card to display. 5. Select Validate.
Note: If the URL is valid, Validate will change to Save. If the URL is invalid, a message will appear briefly that reads, “This website is blocking Commander. Please make sure this is an https URL with a valid source, and the X-Frame-Options header is set to allow.” The website may be blocking Commander or the text entered for Web URL may simply have a typographical error.
6. Select Save.
Hiding and Showing Trend Lines
On a Trend card, hide/show a trend line by toggling on/off the dot matching the color of the trend line that you want to hide/show.
Note: The colored dots are in front of the point names (in the point slots) corresponding to the trend lines. If the point slots are not visible, hover over the area next to the card name and select the resize arrows that appear.
Composing Text on a Text Editor Card
Accessing the Card’s Edit Mode 1. Move over the space to the right of the card’s title. 2. Select the gear icon , which enables the card’s Edit Mode.
Typing, Formatting, and Saving Text 1. Type and format the text as you would in a simple word processor. 2. Close Edit Mode, which saves your changes.
Caution: Close Edit Mode before navigating away from the dashboard. Navigating away before closing Edit Mode discards any changes.
KMC Commander Software Application Guide
71
AG231019E
Creating Links to Web URLs 1. Highlight the text that you want to make into a hyperlink. 2. Select the link icon . 3. Copy and paste into Enter link the web URL that you want to link to. 4. Select Save. 5. Close Edit Mode, which saves your changes. Caution: Close edit mode before navigating away from the dashboard. Navigating away before closing Edit Mode discards any changes.
Using Cards
Writing to a Point
Using the simplified method 1. Select the setpoint slot on the card, which opens a window titled with the setpoint’s name. 2. Enter the new value for the setpoint. 3. Select Write Priority [Default]. Note: The priority given here is the Default Manual Write Priority on page 15, configured in Settings > Protocols.
Note: The value will be written for the duration of the Manual Write Timeout on page 15 (default None), configured in Settings > Protocols.
Using Advanced Settings 1. Select the setpoint slot on the card, which opens a window titled with the setpoint’s name. 2. Enter the new value for the setpoint. 3. Select Show Advanced Settings, which expands to allow you to: l Select a Write Priority from the dropdown menu. l Select a Write Timeout from the dropdown menu.
Note: Write should be selected (by default) for Write Value or Clear Slot.
KMC Commander Software Application Guide
72
AG231019E
Note: A history of the current and previous 10 reads of the priority array displays below. Scroll to the right to view all 10. The interval of the time stamps is partly determined by the Read Priority Array Wait Interval (Minutes) on page 14.
4. Select Write Priority _.
Note: It may take a minute for the point on the device to change to the new value so that the card shows the change. See also the Read Time After Point Writes (Seconds) on page 9, configured in Settings
> Protocols.
Clearing a Priority
1. Select the setpoint slot on the card, which opens a window titled with the setpoint’s name. 2. Select Show Advanced Settings. 3. For Write Value or Clear Slot, select Clear. 4. From the Clear Priority dropdown menu, choose the priority that you want to clear.
Note: A history of the current and previous 10 reads of the priority array displays below. Scroll to the right to view all 10. The interval of the time stamps is partly determined by the Read Priority Array Wait Interval (Minutes) on page 14.
5. Select Clear Priority _.
Note: It may take a minute for the point on the device to clear the value so that the card shows the change. See also the Read Time After Point Writes (Seconds) on page 9, configured in Settings > Protocols.
Flipping to the Back of a Card
Note: You can flip Custom cards, KPI Gauge cards, and Thermostat cards to show more information from a device and command additional points.
1. Move over the bottom edge of the card. 2. Select the Flip to back that appears.
Note: The rows show the present values of all points of interest on that device. Any row that is shaded is a selectable and commandable point. When done, select Flip to front.
Rearranging Cards and Decks on a Dashboard
1. In Dashboards , select Edit Layout (in the upper-right of corner of the dashboard).
Note: This causes the grip icon to appear in the upper-right corner of cards and decks.
KMC Commander Software Application Guide
73
AG231019E
2. Grab (select and hold) a card or deck that you want to move by its grip . 3. Drag the card or deck over to where you would like it to be.
Note: The other cards automatically rearrange to make room for the card.
4. Drop the card or deck in its new location. 5. Keep rearranging cards and decks until the layout is the way you would like it. 6. Select Save Layout.
Favoriting a Card
Prerequisites If you favorite a card, it is added to a Favorites deck. Therefore, you must first have a deck titled “Favorites” for (Favorite Card) to work. (See Finding a Deck in the Deck Library and Using the deck creation area on page 76.) Adding a Card to the Favorites Deck
1. Hover over the upper-right corner of the card. 2. Select the circle that appears, which selects the card. 3. Select (Favorite Card).
Note: If a deck titled “Favorites” exists (see Finding a Deck in the Deck Library), it is added there automatically. If it doesn’t exist, an error message briefly appears. Though the message says “Please create a dashboard titled ‘Favorites'”, you must create a deck titled “Favorites” (see the Prerequisites on page 74).
Hiding and Showing Trend Lines
On a Trend card, hide/show a trend line by toggling on/off the dot matching the color of the trend line that you want to hide/show.
Note: The colored dots are in front of the point names (in the point slots) corresponding to the trend lines. If the point slots are not visible, hover over the area next to the card name and select the resize arrows that appear.
Composing Text on a Text Editor Card
Accessing the Card’s Edit Mode 1. Move over the space to the right of the card’s title. 2. Select the gear icon , which enables the card’s Edit Mode.
Typing, Formatting, and Saving Text
1. Type and format the text as you would in a simple word processor.
KMC Commander Software Application Guide
74
AG231019E
2. Close Edit Mode, which saves your changes.
Caution: Close Edit Mode before navigating away from the dashboard. Navigating away before closing Edit Mode discards any changes.
Creating Links to Web URLs 1. Highlight the text that you want to make into a hyperlink. 2. Select the link icon . 3. Copy and paste into Enter link the web URL that you want to link to. 4. Select Save. 5. Close Edit Mode, which saves your changes.
Caution: Close edit mode before navigating away from the dashboard. Navigating away before closing Edit Mode discards any changes.
Taking Actions From a Report Card
See Using a Report on page 130.
Deleting a Card
Directly from the Dashboard
You can delete a single card or multiple cards at once using the direct method. 1. Hover over the upper-right corner of the card. 2. Select the circle that appears, which selects the card. 3. Repeat for any other cards that you want to delete. 4. Select delete on the toolbar that appears at the bottom of the application window. 5. Select Confirm.
Using a Card’s Menu
You can delete one card at a time using this method. 1. Hover over the upper-right corner of the card. 2. Select the More icon that appears. 3. Select Delete. 4. Select Confirm Delete .
KMC Commander Software Application Guide
75
AG231019E
Creating and Adding Decks
Adding Cards to a New Deck
After Creating and Adding Cards on page 56 to a dashboard, you can add instances of those cards to a deck.
Note: See also Adding a Card to an Existing Deck on page 78.
From a dashboard directly 1. Hover over the upper-right corner of a card that you want to add to a new deck. 2. Select the circle that appears, which selects the card. 3. Repeat step 2 for any other cards that you want to add to the same deck. 4. Select (Add Cards to Deck), which opens the Add card(s) to decks window. 5. Select + New Deck (at the bottom of the list, which makes the text editable. 6. Replace the text with a name for the new deck. 7. Press enter, or select an area outside of the text box. Note: The checkbox for the new deck is automatically selected for you.
8. Select Add. Note: The new deck appears at the bottom of the dashboard. It is also added automatically to the deck library.
Note: You can set the default deck view mode in Settings > Project > Dashboard. See Dashboard Deck Mode on page 9 for details.
Using the deck creation area 1. With the dashboard that you want to add the deck to displayed, select Add Instance. 2. Select Deck. 3. Switch the toggle at the upper-left to Create new deck. 4. Choose the cards that you want to add to the new deck by hovering over a card’s upper-right corner, then selecting the circle for it. 5. Select Continue. 6. Enter a Deck name. 7. Select Submit.
KMC Commander Software Application Guide
76
AG231019E
Note: The new deck appears at the bottom of the dashboard. It is also added automatically to the deck library.
Note: You can set the default deck view mode in Settings > Project > Dashboard. See Dashboard Deck Mode on page 9 for details.
Adding a Deck from the Deck Library to a Dashboard
Once a deck is created, it is added automatically to that dashboard and the deck library. Even if the deck is later deleted from the dashboard, it still exists in the deck library so that you can later add it to the same or other dashboards.
1. With the dashboard that you want to add the deck to displayed, select Add Instance. 2. Select Deck, which opens the deck selection area in the Select existing decks view. 3. Choose the deck that you want to add by selecting the circle for it.
Note: You can add more than one deck at a time by choosing multiple decks.
4. Select Add. 5. Choose to either Add to Top of Dashboard or Add to Bottom of Dashboard.
Note: You can set the default deck view mode in Settings > Project > Dashboard. See Dashboard Deck Mode on page 9 for details.
Modifying Decks
Rearranging Cards in a Deck
1. Go to the deck on a dashboard, or in the deck library.
Note: See Finding a Deck in the Deck Library.
2. Select Rearrange Cards , which makes a Rearrange cards window appear. 3. Drag the card titles and drop them higher or lower in the list to rearrange the left-to-right order of the cards in
the deck.
Note: The cards are listed top to bottom in the order that they appear left to right when the deck is in the Expand Down view mode. (See Switching Between Deck View Modes on page 79.)
4. Select Submit.
KMC Commander Software Application Guide
77
AG231019E
Adding a Card to an Existing Deck
Note: See also Adding Cards to a New Deck on page 76. 1. In Dashboards , hover near the upper-right corner of the card that you wish to add. 2. Select the More icon on the toolbar that appears. 3. Select Add to Decks, which makes a list appear of all existing decks in the deck library. 4. Check the box next to the deck that you want to add the card to.
Note: A confirmation message appears briefly in the upper-right corner of the dashboard.
Note: You can add the card to more than one deck at once (and also remove it).
Removing a Card from a Deck
Using the direct method 1. Go to the deck on a dashboard, or in the deck library. Note: See Finding a Deck in the Deck Library.
2. Hover near the upper-right corner of the card that you want to remove. 3. Select remove/delete .
Using the card’s menu If an instance of a card is placed individually on a dashboard as well as in a deck, you can remove the deck instance using the individual instance’s card menu.
1. Go to the individual instance of the card on the dashboard. 2. Hover near the upper-right corner of the card. 3. Select the More icon on the toolbar that appears. 4. Select Add to Decks, which makes a list appear of all existing decks in the deck library. 5. Clear the checkbox next to the deck that you want to remove the card from.
Note: A confirmation message appears briefly in the upper-right corner of the dashboard.
Note: You can remove the card from more than one deck at once (and also add it).
Editing a Deck’s Title
1. Go to the deck on a dashboard, or in the deck library.
KMC Commander Software Application Guide
78
AG231019E
Note: See Finding a Deck in the Deck Library.
2. Select the deck’s title, which makes an Edit Deck Title window appear. 3. Edit Deck Title. 4. Select Submit.
Using Decks
This section explains how to use features unique to decks. For guidance on using a deck’s cards, see Using Cards on page 72.
Switching Between Deck View Modes
Decks have the following view modes: l Perspective (default) displays the cards in a rotatable carousel, with the central card foregrounded and the surrounding cards smaller in a shadowed background.
l Flat displays the cards in full size in a rotatable carousel, with the central card in full color and the surrounding cards in shadow.
l Expand Down displays the cards similarly to how they look when individually placed on a dashboard (all same size in full color), but grouped together into a single unit.
Note: The deck may expand down to another row, depending on the number of cards in the deck and the width of the browser window.
To switch between a deck’s view modes, toggle the button in its upper-right corner (Switch to Flat / Expand Down / Switch to Perspective).
Note: You can set the default deck view mode in Settings > Project > Dashboard. See Dashboard Deck Mode on page 9 for details.
Centering a Card in a Deck
When a deck is in Perspective or Flat view mode (see Switching Between Deck View Modes on page 79), to change which card is in the center:
l Use the rotate left and right buttons
in the deck’s upper-left corner.
l Click or tap the card that you want to be center, which will rotate the deck and center that card automatically.
Rearranging Cards and Decks on a Dashboard
1. In Dashboards , select Edit Layout (in the upper-right of corner of the dashboard).
KMC Commander Software Application Guide
79
AG231019E
Note: This causes the grip icon to appear in the upper-right corner of cards and decks.
2. Grab (select and hold) a card or deck that you want to move by its grip . 3. Drag the card or deck over to where you would like it to be.
Note: The other cards automatically rearrange to make room for the card.
4. Drop the card or deck in its new location. 5. Keep rearranging cards and decks until the layout is the way you would like it. 6. Select Save Layout.
Deleting Decks
Deleting a Deck from a Dashboard
1. With the dashboard that you want to delete the deck from displayed, select the circle
for that deck.
Note: An orange border indicates that the deck is selected and a white toolbar appears at the bottom of the browser window.
2. Select delete .
Note: After deleting a deck from a dashboard, the deck still exists in the deck library found at Add Instance > Deck > Select existing decks.
Deleting a Deck from the Deck Library
1. Go to the deck library by selecting Add Instance (in Dashboards ), then Deck.
Note: The deck selection area opens with the Select existing decks view (which contains the deck library) displayed.
2. Select the circle on the deck(s) that you want to delete permanently.
Note: To avoid
Documents / Resources
![]() |
KMC Software Application [pdf] User Guide Software Application, Software, Application |