ROAM Portal User Guide: Revised: January 14, 2011

ROAM Portal User Guide
Version 2.3.1
Revised: January 14, 2011
Copyright © 2009, 2010, 2011 Acuity Brands Technology Services, Inc. All Rights Reserved. No part of the
contents of this document may be reproduced or transmitted in any form or by any means without the express
written permission of ROAM and Acuity Brands Technology Services, Inc.
ROAM Portal User Guide V2.3.1.doc
© [2009, 2010, 2011] Acuity Brands Technology Services, Inc., All Rights Reserved
Table of Contents
GETTING STARTED ................................................................................................................................................. 4
PORTAL SET UP ..............................................................................................................................................................4
LOGGING-IN ..................................................................................................................................................................4
TERMS & DEFINITIONS ....................................................................................................................................................5
Diagnostic Definitions.............................................................................................................................................6
TAB OVERVIEW ..............................................................................................................................................................7
DASHBOARD TAB................................................................................................................................................... 8
OVERVIEW ....................................................................................................................................................................8
SINGLE DAY DASHBOARD .................................................................................................................................................8
DATE RANGE DASHBOARD................................................................................................................................................9
DASHBOARD DETAIL ......................................................................................................................................................10
STATUS CODES .............................................................................................................................................................10
ACTIVE LINKS ...............................................................................................................................................................11
EXPORTING..................................................................................................................................................................11
MAPS TAB............................................................................................................................................................ 12
OVERVIEW ..................................................................................................................................................................12
MAP PANNING & CENTERING .........................................................................................................................................12
BASIC NAVIGATION .......................................................................................................................................................12
CONTROL WINDOW & FILTERS........................................................................................................................................15
Diagnostic Filter....................................................................................................................................................16
Diagnostic / Malfunction Icons.............................................................................................................................17
ANSI Lamp Wattage Table ....................................................................................................................................17
Historical Operation Filter ....................................................................................................................................18
Work Order Tracking Filter ...................................................................................................................................19
LIGHTING ASSET INFORMATION .......................................................................................................................................20
Overview...............................................................................................................................................................20
Info .......................................................................................................................................................................20
Attributes ......................................................................................................................................................21
History ...........................................................................................................................................................21
Notes .............................................................................................................................................................22
Work Order Tracking .....................................................................................................................................22
Options .................................................................................................................................................................23
Change MacID ...............................................................................................................................................23
Change DCM MacID ......................................................................................................................................24
Replace Lamp ................................................................................................................................................24
Replace Fixture..............................................................................................................................................24
Set Work Order Status...................................................................................................................................25
Print Work Order Ticket ................................................................................................................................25
Set Priority Flag .............................................................................................................................................26
Add Note .......................................................................................................................................................26
Commands............................................................................................................................................................26
History Graph .......................................................................................................................................................27
Create Work Order/View Ticket ...........................................................................................................................27
SELECTING MULTIPLE LIGHT ASSETS .................................................................................................................................28
RELOCATING NODE(S) ...................................................................................................................................................29
Drag/Drop.............................................................................................................................................................29
Movement Tray ....................................................................................................................................................29
ROAM Portal User Guide V2.3.1.doc 2

REPORTING TAB................................................................................................................................................... 30
STANDARD REPORT .......................................................................................................................................................30
DAILY STATUS REPORT...................................................................................................................................................33
HISTORY TAB ....................................................................................................................................................... 35
7 DAY EXCEPTION .........................................................................................................................................................35
30 DAY EXCEPTION .......................................................................................................................................................38
SELECTED DATE ............................................................................................................................................................39
GROUPS TAB........................................................................................................................................................ 40
OVERVIEW ..................................................................................................................................................................40
CREATING A NEW GROUP ..............................................................................................................................................40
OPTIONS BUTTON.........................................................................................................................................................41
Edit Group ............................................................................................................................................................41
Adding Assets .......................................................................................................................................................42
Clear Group ..........................................................................................................................................................42
Remove Selected Assets.......................................................................................................................................42
Delete Group ........................................................................................................................................................42
GROUP LIST / DASHBOARD .............................................................................................................................................43
COMMANDING GROUPS ................................................................................................................................................44
SCHEDULING TAB................................................................................................................................................. 45
OVERVIEW ..................................................................................................................................................................45
GROUP PRIORITIES ........................................................................................................................................................46
MANAGE SCHEDULES ....................................................................................................................................................46
Create a New Schedule.........................................................................................................................................48
Edit Existing Schedule...........................................................................................................................................48
Delete an Existing Schedule..................................................................................................................................48
MANAGE EVENTS .........................................................................................................................................................49
Create New Event.................................................................................................................................................50
Edit Existing Event ................................................................................................................................................50
Delete an Existing Event .......................................................................................................................................50
DIMMING ...................................................................................................................................................................51
ADDING/EDITING WEEKLY SCHEDULES AND DAILY EVENTS TO THE CALENDAR ..........................................................................51
Single Week Schedule...........................................................................................................................................51
Date Range Schedule............................................................................................................................................52
Single Day Event ...................................................................................................................................................53
Date Range Event .................................................................................................................................................54
Edit Schedule ........................................................................................................................................................54
Removing an Applied Schedule or Event..............................................................................................................55
VIEWING RESULTS OF WEEKLY SCHEDULE COMMUNICATION ................................................................................................55
Command Results Detail ......................................................................................................................................56
WORK ORDER MANAGEMENT TAB ...................................................................................................................... 57
GENERAL FUNCTIONALITY...............................................................................................................................................57
WORK ORDER DASHBOARD ............................................................................................................................................58
Dashboard Detail ..................................................................................................................................................58
CREATING WORK ORDERS ..............................................................................................................................................59
Create Sub-Tab .....................................................................................................................................................59
Dashboard, Reporting, History, and Groups Selection .........................................................................................60
Map Tab – Single or Box Band Selection ..............................................................................................................60
MANAGE ....................................................................................................................................................................62
ROAM TECHNICAL SUPPORT................................................................................................................................ 63

Getting Started
Portal Set Up
Enable ActiveX Controls: Users will need to enable ActiveX controls to optimally work with the ROAM
portal:
1. Go to Tools on the menu bar

2. Select Internet Options
3. Select Security
4. Select Custom Level
5. Scroll to ActiveX Controls
6. Enable all ActiveX except “Allow Scriplets” and “Display Video and Animation”
7. Select OK
8. Select Yes to Save Changes
Logging-In
Open your internet browser and type in the ROAM URL – https;//ww2.roamportal.net
Type in your username and password, then click “Log-In”. This will take you to the main page.

Terms & Definitions
Node - A node is a ROAM photocontrol, which collects data from the lighting asset and sends the data
wirelessly to the Gateway.
Standard Node Decorative Node
Dimming Control Module (DCM) - A DCM is a ROAM dimming control module that is provided in a
dimmable LED fixture, preinstalled inside the LED fixture. The DCM controls the dim level of the fixture by
adjusting the input into the dimmable driver of the fixture. The DCM is paired with the node installed on
the fixture during that activation process to allow dimming to occur through schedules, events and
commands.
Gateway - The gateway is the backhaul device that collects all the data from the nodes and transmits the
information back to the Network Operation Center, or NOC.
MacID - The 16 digit MacID is the ROAM node’s unique identifier assigned to the internal radio, with the
format of “00161N00xxxxxxxx”. The barcode on the node itself only displays the final 8 digits of the full 16
digit MacID. The first 8 digits will always be “00161N00”. Once activated, this MacID is associated with the
light on which it is mounted. All attributes and location captured at installation create a one-to-one
association between the light and the ROAM node, which is why it is important to follow ROAM node
replacement processes.
Last 8 digits of MacID. Full

MacID of this node is
“00161N000000C4CD”

Diagnostic Definitions
Fully Operational
• Fixture/lamp is functioning normally.
Operational With Issues

• Fixture/lamp is functioning (emitting light), however it is not performing optimally. Problems can
include (but are not limited to) cycling, day-burning, mis-wired fixtures, low voltage, high voltage,
high v-delta, excessive wattage, high current or failed ROAM node. It is likely that a fixture in this
condition would be observed burning at night and off during the day (unless it is a day-burning
issue).
Fixture Malfunction
• Fixture/lamp is not operating normally. The fixture is operating below the fixture malfunction
threshold (default value is set to the expected ballast only wattage – see wattage chart) for at
least 2 reports during the on period. Problems can include (but are not limited to) the lamp,
starter, ballast, capacitor, failure of the ROAM node or voltage issues. It is likely that a lamp in
this condition would not be observed burning at night due to the extremely low wattage.
Low Wattage
• Fixture/lamp may or may not be functioning (emitting light); however it is not performing
optimally. The fixture is operating below the low wattage threshold and above the ballast only
(fixture malfunction) threshold for the installed lamp. The default threshold is defined to be
operating between the ballast only threshold and the low end of the recommended operating
range for the lamp size that is installed. The user may request the thresholds to be modified
based on their business rules. Whether the lamp is actually emitting light or not cannot be
predicted with any confidence in this category.
No Communication
• Contact with the ROAM node has been lost for 96 hours or less, rendering the ROAM node
incapable of diagnostics. Nodes that exceed the 96 hour threshold will begin reporting as
unspecified malfunction. Problem can include (but is not limited to) loss of power to the ROAM
node, a bad fixture, node lock-up, cellular disruption, failure of the ROAM node or RF
interference.
Unspecified Malfunction
• Contact with the ROAM node has been lost in excess of 96 hours, rendering the ROAM node
incapable of diagnostics. A fixture in this condition may or may not be observed burning at night.
Problem can include (but is not limited to) loss of power to the ROAM node, a bad fixture, node
lock-up, cellular disruption, failure of the ROAM node or RF interference.
Partial Report
• Insufficient data was received from the field to accurately diagnose the condition.
No Power at Activation
• There was no power at the time the ROAM node was installed and activated. Once the power is
restored, the node will register and begin reporting properly.
Unregistered
• ROAM node was activated on a light with power, but has not registered on the system. Problem
can be improper activation, power, fixture or ROAM node.

Menu Bar - Tab Overview
There are up to seven main tabs at the top of the portal screen, depending on which premium services have been
purchased. Some tabs feature sub-tabs with control and filter functions to direct the information displayed in the
content window or map. Below is a description of the information found under each tab:
Dashboard – System-wide performance summary for any specific date or date range
Maps
• Light assets displayed in map view format
• Color-coded assets display current diagnostic status
• Information on light asset (both general and detail)
• Ability to create and track work orders, set priority flags and add user and work order notes
• Access to historical operational performance on light assets
• Ability to send immediate commands to a light asset
Reporting - Status exception reporting based on date range options
History - Historical light asset performance and detail information
Scheduling (Premium Functionality) - Allows user to schedule operating hours for individual or groups of
assets
Work Order (Premium Functionality) - Allows user to create, assign and track work orders for light assets
in need of repairs
Groups (Premium Functionality) - Allows user to group assets according to their business
rules/preferences
Referenced below are some other common navigation terms to help familiarize users with the portal:
Quick Select Buttons:

Main Tabs (Maps Tab currently enabled) - Commands
- Search for light assets
- Edit profile
- Log-out
- On-line documents
Control Window

Dashboard Tab
Overview
The dashboard provides users with a visual summary of the system performance for a single date or a range of
dates for any given installation. If users have multiple installations, the current system performance can be shown
for all locations at one time. The system performance totals include all device types; nodes, dimming control
modules, gateways and repeater nodes. The user may choose to view the summary for a single device type by
selecting a specific type in the Device Type drop down menu.
If Single Installation is selected, options for Single Date or Date Range are available.
The Single Date option defaults to yesterday’s date (current status). Clicking on the
calendar icon will allow the user to change the date. The Date Range option defaults
to the previous 30 days. Clicking on either of the two calendar icons will allow the
date range to be changed. Once the correct date has been chosen, the Refresh
button must be selected to generate the results.
The single date dashboard displays a break-down of status categories for all light
assets, along with a pie chart of percentages in each category. The date range option
will display the break-down of status categories for each day of the date range, with
two bar graphs. One indicates the entire system summary and the other shows just
exceptions. Users can export the displayed data to Excel, PDF or XML.
Single Day Dashboard
Export Buttons
Clicking on the numbers in the columns will bring up a detailed list of

light assets currently in that diagnostic condition (See Dashboard Detail
below)
Note: Included in Activation category will be “No Power at Activation” as well as “Unregistered”.

Single Day Dashboard (Pie chart showing Nodes for device type)
Date Range Dashboard

Dashboard Detail
After double-clicking on a number in the column on the dashboard, a list of light assets in that specific diagnostic
condition will appear, along with the light assets’ status for the last seven days. Below is an example of the data
available from Dashboard Detail:
City, State and Zip can be removed from

Click on either a Device or MacID to bring up display at customer’s request, as well as
the asset information selections. Address
Click inside cell to view the work Click on either a latitude or longitude to
order ticket. jump to light asset location on map.
Status for last seven days

displayed in columns
To conserve space in lists and reports, customers may request to turn off the entire address or just the City, State
and Zip if this information is not desired.
Status Codes
Status codes showing in dashboard detail will feature two letters, which indicate the current condition, and a
number, indicating cycle count. The color shown under the specific date will match the color for the diagnostic
status in the Diagnostic control window legend.
For example, the status code below indicates “Unspecified Malfunction” with “0” Cycle Count” detection:
Status Code displayed, along with

Status Code Reference
the cycle count.
G Good /Operating Normally
OI Operational With Issues
UM Unspecified Malfunction
FM Fixture Malfunction
LW Low Wattage
NC No Communication
PR Partial Report
NP No Power at Activation
UR Unregistered

Active Links
Active links have been provided consistently in all lists and reports. These links include the following:
• Clicking on a specific Device ID or MacID field will display the asset information popup.
• Clicking on a specific Latitude or Longitude field will snap to that asset in the Map view.
• Clicking on a specific WO (Work Order) field will display the current work order ticket.
• If the MacID field is hovered over for more than ¼ second, the Node Detail Popup will display with current
information on that node.
• Clicking on Column Headings will sort the list using the data in that column. The sort will toggle between
ascending and descending order with repeated clicks.
Exporting
Whenever the Excel, PDF or XML icons are shown to the left display on a list or report, the user may
export the data within the list or report to one of these applications.

Maps Tab
Overview
The Maps Tab displays lighting assets in a graphical map-view format. Normal operating lights, as well as those in a
malfunction condition, are color coded for easy visual identification on the map. From the map screen, users can
quickly identify malfunctioning lights, access details for each light, view operating history, set work order flags and
more.
Map Panning & Centering

• To pan the map, right click the mouse button, hold down and drag to position on the map.
• To center the map, right click the mouse button once at the desired new center location. At the
street level, centering will not work while the mouse is directly over an asset.
Note: Refreshing the map by panning, centering, and zooming (see Basic Navigation) may take
several seconds. During this time the interface will not accept additional commands or instructions
Basic Navigation
Below is a reference for basic navigation on the map tab. Descriptions are shown below for
frequently used functions:
9. Command
1. Zoom
10. Search
2. Information Window
11. Profile
3. Map Refresh
12. Log-Out
4. Bookmarks
13. Documents
5. Show Counts
14. Lat/Long Display
6. Output
7. Clear 8. Show Group
1. Zoom – Allows user to control zoom level inside the content

Three Pre-Sets
window. The zoom toolbar remains hidden unless the user
- Street
hovers over it with the mouse.
- City
- State
There are 3 zoom presets included for convenience. Asset
detail and asset selection are only available from Street Level.

2. Information Window – Displays current time, user id and current bookmark.
3. Map Refresh – The map should be refreshed upon any user initiated action, including checking or
un-checking diagnostic conditions, moving between Control Window filters or moving between
Main Tabs.
4. Bookmarks – Allows user to create, edit and save bookmarks for specific views, enabling users to
quickly return to those specific views throughout the session or upon a future log-in.
After selecting Bookmark, a pop-up box will appear

that lists all saved bookmarks.
Selecting New Bookmark allows user to create a

new bookmark for the current view.Selecting the
pencil icon allows user to edit the name or view for
that bookmark. Selecting the ‘X’ will delete that
bookmark. Select Close to cancel the bookmark
request and close the pop-up box.
5. Show Counts– Allows users to see a summary count of light assets displayed in the current view.
(Note that this is not a system-wide count unless the user is zoomed out to the extent that the
entire system is visually displayed in the content window.)
After selecting Show Counts, a pop-up box

will appear providing a count summary of
light assets in the current content window.
Select Close to cancel the asset count

6. Output– Allows users to create a copy of the current screen shot that can be saved, e-mailed or
printed so that the map can be used outside of the portal program. Once the Output button is
selected, the user can right click in the display window and choose the option they wish to
perform.
7. Clear – Allows users to clear any current asset selections.

8. Show Group – This allows the user to select assets displayed on the screen by choosing any of
the groups previously created for the active installation. In order to select the assets, the user
must click on the refresh image button. This is also a quick way of identifying those assets
included in the selected group.
9. Command – Displays recent command history on selected lights.
After selecting command, a pop-

up box will appear providing
details on commands issued for
last 30 days.
Commands can be deleted from

the list by selecting “X” under
Delete column. Select Close to
close the pop-up box.
10. Search – Allows user to search for specific light asset by MacID, Lat / Long, Device ID or Address.
Note that a zip code is required to conduct an accurate street address search. The Fuzzy ID
search allows users to enter a partial MacID or device id (commonly a pole number) and retrieve
a list of lighting assets that include that string of characters. The Gateway ID search allows user
to search for a specific gateway MacID.
After selecting Search, a pop-up box

will appear with available search
options. Click on appropriate search
criteria.
Select Close to cancel the search

11. Profile Editor – Allows user to edit their individual profile including name, password, default
bookmark and default screen upon log-in.
After selecting the Profile Editor, a pop-up box

will appear that allows the user to update
his/her profile. Update profile as necessary.
Click Save to save the changes or Cancel to

cancel the profile editor changes and close the
pop-up box.
12. Log-Out – Allows user to discontinue use of the ROAM portal, ensuring a proper disconnection.
Once logged out, the internet browser may be closed.

13. Document Button – Allows users to access important ROAM documents in PDF format. Once the
list of documents is display, the user can select the document they wish to view and/or print,
which will then be displayed using Adobe Acrobat Reader.
14. Latitude / Longitude Display – Indicates latitude and longitude coordinates, based on cursor
position (Note that the lat/long coordinate will display anywhere the cursor is positioned on the
map. The user does not have to have the cursor directly on an asset to see lat/long).
Control Window & Filters

The Control Window defines the display of information in the Content Window or Map view.
Overview - The Control Window includes 4 filter overlays including Diagnostic, Historical Operation Status
Work Order Tracking and for some users, Work Order Management (Note that Work Order Management
will only be functional for those customers that have purchased the ROAM Work Order Management
Module).
Control Window Filters selected determines

the information that is shown in the content
window (the map here)

Diagnostic Filter
Users can select specific malfunction conditions to display on the content window or map by checking and
un-checking malfunction types. Only lights with the diagnostic condition(s) checked will be displayed in
color on the map. All other lights will display as clear circles.
Diagnostic Filter (current filter will display blue check marks)
Mouse Over Definitions will display a definition of the diagnostic condition

when the user holds the mouse over the circular diagnostic icon
ANSI Info – Clicking on the Fixture Malfunction and Low Wattage icon will
provide ANSI information in a pop-up box (see below)
Other Filters:
- Historical Operation
- Work Order Tracking
- Work Order Management (may not be enabled for some
customers)
- Show Gateways Only
Show Gateways Only Filter

Selecting the Show Gateways Only box will remove all device types, except gateways, from the content
window so the user can quickly determine gateway status and location. Gateways that have not
communicated with the Network Operations Center within 6 hours will display red. Green gateways
indicate that ROAM is receiving data from them as expected.

Diagnostic / Malfunction Icons
See Terms & Definitions sections for description of diagnostic conditions.
Diagnostic / Malfunction Icons for DCMs

Due to the operation of the dimming control module, the DCMs will not be diagnosed for Fixture
Malfunction or Low Wattage. If a DCM is present, then the DCM status will be displayed on the bottom
half of an asset icon as shown here. In this example, the node installed on the fixture is reporting a fixture
malfunction, while the DCM is fully operational.
ANSI Lamp Wattage Table

The lamp wattages listed below are used to determine Fixture Malfunction, Low Wattage and Excessive
Power statuses, plus provide the % of Rated Wattage for the various types of lamps. These are average
industry rated values for the different types of lamps provided by manufacturers. The thresholds listed in
the table may be modified for a specific customer at the customer’s request.
ANSI Lamp Wattage

reference appears in pop-up
box after clicking once on the
circular icon for either
Fixture Malfunction or Low
Wattage.

Historical Operation Filter
Status helps users determine the status of a light asset on a specific date and time, and have the light
visually display on the map.
Historical Operation Status Filter Selected

(previously selected filter will collapse)
Status Conditions to choose from
Clicking Select Date will display the

calendar pop-up. Choose the Date
and Time you wish to see. Select OK
Always select Refresh Map after to retrieve information or cancel to
initiating action cancel the request.
Below is an example of Historical Operation information retrieved after selecting to see Issues
(malfunctions) only in the map view, which existed on 9-23 at 3:00AM.
Only assets that were reporting an

“issue” or malfunction at 3AM on 9-23
will be highlighted on the map

Work Order Tracking/Work Order Management Filter
User can utilize the Work Order Tracking or Work Order Management filter to see light assets on the map
that currently have work orders, notes or a priority flag.
Under Work Order Tracking, there are 3 work order types available for use in accordance with the
customer’s business rules. Under Work Order Management, the user can choose to show assets with
work orders in the 3 statuses (Queued, Assigned or Dispatched)
Work Order Tracking Filter Enabled

Work Order Management Filter Enabled

Work Order Types 1, 2 and 3, Work

Order Note and Priority Flags
Work Order Statuses: Assigned,

Queued, Dispatched, Work Order
Note and Priority Flags
Lights with the selected work order type(s), priority flag or note will display on the map. Light assets with
work orders will be displayed with an orange cone; light assets with a priority flag, will display with a “!”
and light assets with a work order note will display with a yellow note (see examples below).
Light Asset has a work order and priority flag
Light Asset has a work order note

Lighting Asset Information
Overview
Each light asset in the ROAM system has a unique “MacID”. A MacID is a 16 digit number that distinguishes
light assets from one another. The light’s MacID will appear in the content window when the user hovers over
the asset with a mouse
Note: The user must be at street level zoom for this feature to work.
In addition the light’s MacID, pertinent information about the asset will display in a pop-up window (Node
Detail Pop-up) while the user is hovering over the light asset. The Node Details Pop-up is located in the bottom
left corner of the screen.
MacID will display on map when

user hovers over the asset using the
mouse for more than ¼ second
Node Detail Popup - Displays MacID, device name (such as

pole number), lamp information, yesterday’s average
wattage (with calculated percent of rated wattage), last
communication, current status and known issues when the
user hovers over the lighting asset. If customer has
purchased work order management, a note is displayed
with the status if an open work order exists on that light
asset.
Detailed information for each light asset can be obtained by right-clicking on the light on the map. A pop-up
box will appear with six options; Info, Options, Commands, History Graph, Create Work Order/View Ticket and
Cancel. By selecting Info, the user can access detailed information on a light asset’s Attributes, History, Notes
and Work Order Tracking History.
”Create Work Order” will

Right click on the light be an option if no work
and select “Info” order has been created
”View Ticket” will be an

option if a work order has
already been created

Info
By selecting Info, the user can access detailed information on a light asset’s Attributes, History, Notes and
Work Order Tracking History.
Attributes
After selecting “Info”, a pop-up box will appear with “Attributes” as the default selection in the pull-down
menu.
Attributes provides the user with details on the light’s attributes including MacID, Lat/Long, address and
other details captured at activation per the customer’s specifications. Any attributes that display a pencil
icon are allowed to be edited. Attributes that do not feature a pencil/paper icon must be edited by ROAM
personnel. Authorized users are able to edit MacID and Lat/Long by other methods, which are covered in
other sections.
A pencil icon next to an attribute

indicates that the attribute can
be edited by the user.
History
Selecting “History” from the pull-down menu provides user with the previous 30-day history on the light
asset’s performance.

Notes
Selecting “Notes” will display the history of user, work order tracking and work order management notes
for the light asset.
User can see all notes associated

with that particular asset.
The date, time and user id is

captured and recorded each time
a note is entered
Work Order Tracking

Provides the user an audit of work order flags that have been set and removed for a lighting asset.
User can see:

- Existence of a work order
- Type of work order (1,2 or 3)
- When the work order flag was set
- When the work order flag was removed
- User setting/removing flags

Options
Users can exercise up to 8 options for a light asset including change MacID, Change DCM ID (if customer has
dimmable LED fixtures), Replace Lamp, Replace Fixture, Set Work Order Status, Print Work Order Tracking
Ticket, Set Priority Flag or Add a Note.
Right Click on Asset; Select Options.

A pop-up box will appear with the
various available options
Change MacID
When ROAM nodes are replaced in the field during routine maintenance, the new replacement node’s
unique MacID will need to be updated on the ROAM portal. The “Change MacID” feature allows an
experienced user the ability to facilitate this change directly on the portal. A fully implemented work
order management program will handle this through the handheld devices.
User must enter the new MacID shown

on the barcode of the replacement
ROAM node and enter a reason for the
change so that there is a record of the
former MacID. (It is not necessary to
enter the preceding zeros on the label)

Change DCM ID
When ROAM DCMs are replaced in the field during routine maintenance, the new replacement DCM’s
unique MacID will need to be updated on the ROAM portal. The “Change DCM ID” feature allows an
experienced user the ability to facilitate this change directly on the portal. A fully implemented work
order management program will handle this through the handheld devices.
User must enter the new DCM ID shown on the

barcode of the replacement DCM device and enter a
reason for the change so that there is a record of the
former DCM ID. (It is not necessary to enter the
preceding zeros on the label)
Replace Lamp
Allows the user to update the manufacturer, lamp type, wattage and install date of the lamp/driver
installed in a fixture. Updating lamp/driver install date allows a user to track the life for a particular
lamp/driver, plus resets the burn hour times in Reports allowing the user to address warranty concerns.
Replace Fixture
Allows the user to update the manufacturer, fixture type and install date of the fixture installed. Updating
the fixture install date allows a user to track the life for a particular fixture to address warranty concerns.

Set Work Order Status (Not necessary if Work Order Management is used)
There are 3 work order types available and can be used in accordance with the customer’s business rules.
The user also has the option at this point to place a priority flag on the light. The work order flag and
priority flag can be used simultaneously.
User will select the work order type (1, 2 or 3) and a

priority flag if desired.
Users must enter a reason for setting the flag for

audit purposes. User will click submit to create the
work order flag or cancel to cancel the request
To remove a work order flag, user will follow same steps as required to set a flag except user will select
“None” from work order type pull-down menu. A reason is also required for removing a work order flag.
Print Work Order Ticket(Not necessary if Work Order Management is used)

The work order ticket is a simplistic method for distributing work load.

Set Priority Flag
A priority flag is available for use in accordance with the customer’s business rules.
User will select Yes to set a priority flag.

Users must enter a reason for setting
the flag for audit purposes. Click Submit
to create the priority flag or cancel to
cancel the request
To remove a priority flag, user will follow same steps as required to set a flag except user will select “No”
from priority flag pull-down menu. A reason also is required for removing a priority flag.
Add Note
Users can add two types of notes – User Notes and Work Order Notes.
User notes are commonly defined and used in accordance with the customer’s business rules.
Work Order Notes are specifically for circumstances and conditions related to work orders.
User will select the type of note they

wish to enter and enter desired note in
the text field provided.
Users will click Submit to save notes or

Cancel to cancel the request.
Commands
Users with appropriate permission can send On/Off and dimming commands (if customer has dimmable LED
fixtures) to individual or multiple assets through the command button. The Dim Fixture display will only show
if the customer has DCM’s installed. In order to select multiple assets, follow the instructions found in the
“Selecting Multiple Assets” section. When the command button is chosen, the total number of assets selected
will be shown in the asset command box that displays.
Commands are instantaneously sent upon choosing the Send button. Command durations are entered in
minutes, with the maximum length of 1440 minutes (24 hours). Latency of the command taking affect will
depend on the mesh network configuration, but will generally occur within a minute from execution.

History Graph
Users can display an historical graph of the low voltage, high voltage and maximum power recorded for an
individual asset for the past 30 days by choosing History Graph.
Create Work Order/View Ticket

The Work Order Management module is covered in more detail in the Work Order section of the User
Guide. Since ROAM will only allow one open work order to be assigned to each asset, the View Ticket
button will display when you right click on an asset that already has a work order generated on it. By
clicking on the View Ticket button, the work order ticket will be displayed and can be printed from this
screen. The Create Work Order button will display if no work order has been created, allowing the user to
create a work order for an individual asset or multiple assets that have been selected (see below).
”Create Work Order” will

be an option if no work
order has been created
”View Ticket” will be an

option if a work order has
already been created

Selecting Multiple Light Assets
To this point, this document has covered accessing general and detail information, exercising options and
commands for individual lighting assets from the Map tab. However, users also have the ability to select multiple
lighting assets. Selection of multiple assets is most commonly used in the retrieval of information for reporting and
history purposes. There are also the options to issue on/off commands and create work orders for multiple lights.
Box Band Selection - To select a group of light assets on the map, click the left mouse button & drag the
mouse around the light assets you wish to select, forming a band. Once banded, the selected light assets
will display with a thumbtack. Additional assets can be added or deleted by repeating the box band
procedure.
Individual Selection - In order to select individual lights that are not contiguous, use the left mouse
button to drag a box around each light you wish to select.
NOTE: Only the assets displaying the diagnostic conditions selected from the Control Window will
be selected using the box-banding method.
Select Clear to remove the

thumbtacks & selection Click on dropdown arrow to
display list of Groups
Show Group Refresh button
Show Group Selection – The Show Group selection allows the user to thumbtack all assets within the
selected group, regardless of the diagnostic conditions selected. Once the desired group is selected from
the dropdown list, click the Show Group Refresh button to display the thumbtacks.

Relocating Node(s)
Occasionally, it may become necessary to modify the Latitude/Longitude coordinates of a node or multiple nodes.
Reasons for relocating a node may be relocation of a pole, inaccurate or missing GPS points collected during
activation or to provide clarity when viewing on the portal. The location of a node can be changed by either of two
methods, the use of the Drag/Drop or Movement Tray feature.
Drag/Drop
When a user needs to relocate a node a short distance, it is recommended that the Drag/Drop feature is
used. The location of a specific node can be changed by pressing and holding the <Ctrl> and <Shift>
buttons, then left click and hold the mouse button on the node that needs to be relocated. The node can
now be dragged to the desired location. Once the left mouse button is released, the node will have been
repositioned at the new location. The new Latitude and Longitude is automatically generated for this
location and stored in the attributes section.
Movement Tray
When a user needs to relocate a node more than a few feet away, it is
recommended that the Movement Tray is used. The location of a
specific node or multiple nodes can be changed by placing the node(s)
into a movement tray. The node(s) can then be moved using the map
to determine the new location. From the map view, a node is placed
into the movement tray by holding down the <Ctrl> key and left
clicking on a node. A pop-up box will ask to confirm the placement
into the movement tray. Once confirmed, the movement tray will
display in the bottom left corner of the map area. Multiple nodes may
be added to the tray prior to placing them at their new location.
To relocate a node once it is in the movement tray, select the Relocate button. The Lat/Long window will
display asking for the new coordinates. The coordinates can be automatically entered by holding the
<Shift> key down and left clicking on the map location where the node should be relocated. Enter a
reason for the move in the appropriate box and click the Submit button.

Reporting Tab
The Reporting Tab has two sub-tabs, Standard and Daily Status.
Standard Reports
Standard Reports includes those for Unregistered Nodes, No Power at Activation, Burn Hours, Asset Notes, Burn
Hour Details, Diagnostic Issues and Monthly KWH Summary.
Unregistered Nodes – A light asset in the unregistered status indicates that the ROAM node has not
communicated with the network, even though the activation process was completed properly.
“Unregistered” should be a temporary status that resolves itself within 48 hours of being activated. Any
light asset in an unregistered condition for longer than 48 hours indicates a problem which should be
investigated.
No Power at Activation – A light asset in the No Power at Activation status indicates that there was no
power at the location when the ROAM node was installed. Users can utilize this report to track and
manage power problems that existed during the activation process and to initiate corrective measures.
Once power is restored, the ROAM node will register and the fixture will be automatically removed from
this status.
Burn Hours – The Burn Hour report provides burn hours and kilowatt hours for the specified date and
cumulative burn hours and kilowatt hours since node activation. The report can be filtered by lamp type
and lamp wattage.
User selects a date, lamp type and lamp wattage
Asset Notes – Asset Notes report allows user to retrieve reporting for various notes set for a light assets,
based on a user selected date range. User enters a start date, end date and selects from a pull-down
menu, the type of notes they would like to retrieve. Users can choose a single note type, multiple note
types or all notes. Note types include:
• Change MacID Notes: Notes regarding the “reason” a MacID was changed.
• User Notes: Any user note entered from the Options screen.

• Set Priority Flag Notes: Notes regarding “reason” a priority flag was set / un-set
• Set Work Order Flag Notes: Notes regarding “reason” a work order flag was set/un-set
• Lat / Long Change Notes: Notes regarding “reason” a lat/long was changed
• Attribute Change Notes: Notes regarding change to an attribute (pole type, address etc.)
• Work Order Tracking Notes: Record of a work order flag being set
Burn Hour Detail – The Burn Hour Details report provides for each fixture, the number of operating hours
and kilowatt hours used for each day of the specified month, plus the monthly totals. The report can be
filtered by lamp type and lamp wattage.
User selects the month, year, lamp type and lamp

wattage

Diagnostic Issues – The Diagnostic Issues report allows the user to create a list of nodes with specific flags
within the Operational with Issues category. For example, if the user would like to address only those
nodes that are dayburning and excessive wattage, these two issues can be selected by holding the <Ctrl>
down while making the appropriate selections. This will allow the user to create work orders for a specific
category.
Monthly KWH Summary – The Monthly KWH Summary report provides a breakdown of the quantity of
each type of fixture, along with subtotals and total kwh’s used for the selected month.

Daily Status Report
The Daily Status Report provides the user with exportable reports indicating the latest status of selected assets.
Filters are provided to further limit the selections within the report.
Asset Selection Filter Options provide the initial subset of

assets, to which the additional filters are applied.
Work Order Filters on Work Orders, Work Order Notes

and Priority Flags.
Diagnostic conditions are selected in the

Control Window
Asset Selection Options
All – All assets for the given installation
Assets on Map – All assets selected in the Control Window that are currently displaying on the
Map
Device Identifier – Typically a MacID but can also be a Device ID, which is most commonly a pole
number
By Group – Organization is a grouping established by the customer
Map Selected – Light assets currently selected on the map (displayed with a thumbtack in Map
Tab)
Yesterday – Lists all light assets that are currently (yesterday’s data) within the diagnostic
statuses checked in the control window.
3, 5 and 7 Consecutive Days – Lists all light assets that have been within the diagnostic
statuses checked in the control window for 3, 5 or 7 consecutive days

Below is an example of a report run to capture light assets that have displayed a malfunction condition for
5 consecutive days without any filters for work orders, notes or priority flags. Diagnostic conditions
currently selected are operational with issues, fixture malfunction, and unspecified malfunction:
Sort by Columns
Click on MAC to view Click on lat or long to go to

Node Detail Popup the light asset on the map
light asset details

History Tab
The History Tab features three sub-tabs to assist the user in viewing performance history for lighting asset - 7 Day,
30 Day and Selected Date.
Select 7, 30 or Selected Date
Choose the Light Asset(s) for which you would like to view performance
history for (these are the same filters available in Reports)
7 Day
7 Day History displays light asset history for last 7 days that can be further specified by the filter the user selects.
Below is an example of a 7 Day History Report run requesting a list of all the light assets with a status for yesterday
of operational with issues, fixture malfunction, or unspecified malfunction.
View previous time period
Number corresponds with

the day of the month
Indicates dimmable fixture
Colors correspond with

diagnostic conditions in
the Control Window
If light asset has a work

More detail is available by
order, priority flag or note,
either double clicking (hour by
it will be indicated in the
hour detail) or right clicking
appropriate column
(power vs. voltage graph)
Node Detail Popup - Displays MacID, Device Name

(such as pole number), whether it is a dimmable
fixture, lamp information, current status and known
issues when the user hovers over the lighting asset,
plus whether a open work order exists on the light
asset

Dimmable fixtures – Any fixture that has been supplied with a DCM preinstalled inside the LED fixture is
capable of being dimmed. As mentioned earlier, the DCM is paired with the node installed on the fixture
during that activation process to allow dimming of a particular fixture. Any dimmable fixture will be
denoted with a crescent moon icon displayed in the MacID column as shown below.
Detail Numbers on History - Two numbers will display for most of the diagnostic conditions. The top
number is the cycle count. The bottom number is the maximum wattage.
0 cycles
105 Watts
Absence of Detail Numbers - If there are no numbers in a red box, the malfunction condition is such that
communication with that node has been lost for at least 24 hours (one day) and no data was received at
the NOC. In other words, there is no detailed hourly information to display.
Hour-By-Hour Detail - Left-clicking on the numbers inside the box will bring up a detail report with hour-
by-hour performance for the light asset such as relay status, wattage, high and low voltage and alerts. The
alerts can be cycle counts, when the light turns on, when the light turns off or if the node detects an issue
at the asset. The alerts are line items without wattage & voltage detail. If the fixture is a dimmable fixture,
then the DCM detail will be included below the node detail. An example of the node and DCM detail that
can be retrieved by double-clicking on the numbers inside the box is shown below:
Hourly data
Turn-off time
Turn-on time
Cycle alert
Hourly DCM
data

Power / Voltage Chart - Right clicking on the box will produce a power and voltage comparison, plus the dim level
if a DCM is present.
Midnight
Setting Work Order Status, Print WO Tracking Ticket, Set Priority Flag or Add Note - Right clicking on the
MacID will enable a pop-up box, allowing the user to establish a work order status, priority flag or enter a
note from the history screen. Once flag is set, the work order icon will display on the map and other areas
on the portal to note the presence of a work order.

30 Day
30 Day History displays light asset history for last 30 days that can be further specified by the work order and
priority filters the user selects. Below is an example of a 30 Day History Report run requesting a list of light assets
with most recent 3 consecutive days with any of the following conditions: Operational with Issues, Fixture
Malfunction, Fixture Malfunction - low wattage or Unspecified Malfunction.
Malfunction Conditions to be included

in the historical search
Users can access the same detail information as in 7 Day History by double-clicking on any box with
numbers (cycle count on top; watts on bottom) or right clicking to see a power/voltage graph by right
clicking.

Selected Date
Selected Date History report allows user to select a specific date and see history 30 days prior to that date. List can
be further narrowed with available filters. Below is an example of a Selected Date History Report run requesting a
list of light assets since 10-22-08 that have recent 7 consecutive days with any of the following conditions:
Operational with Issues, Fixture Malfunction, Fixture Malfunction - low wattage or Unspecified Malfunction.
Users can access the same detail information as in 7 Day History by double-clicking on any box with
numbers (cycle count on top; watts on bottom) or voltage / power comparison graph by right-clicking.

Groups Tab
Overview
Lighting assets can be grouped for administrative use, selective reporting, and controlling assets (scheduling,
events, and immediate commands). Lights must be assigned to a group or groups in order to utilize the Scheduling
functions.
• The Options Button is used to manage and edit groups.

• A Dashboard (see page 8) is displayed by selecting a group from the Group list.
Group List
Options Button
- Create Group
Group Dashboard - Add Assets
- Clear Group
- Delete Groups
Create a New Group

1. From the Groups tab, click “New Group” in the Group List. (Previously created groups are listed under
“<New Group>”).
2. The New Group screen appears.
3. Enter new group name.

4. Check the box if the group will be used for scheduling and or events.
5. If the group will be used for scheduling and or events, enter a priority for the group. The default priority is
127. The highest priority is 1. The priority can be modified at any time to meet scheduling requirements.
Refer to Scheduling Section of the user guide for an explanation of priority.
6. Click Save.
7. An Alert will appear indicating that the new group has been added.
8. The new group will appear in the group list.

Options Button
Only the creator (or ‘owner’) of a list can make changes to or delete a group. Other users may view or use the
group. Assets added to a group by Diagnostic Status will remain in the group until it is removed by the owner
of the group. If the asset’s status changes due to a malfunction or a repair, it will still remain in the group.
To modify the group, the owner of the group must select the group from the Group List and then select the
Options button. The Edit Group window will appear, allowing the owner of the group to Edit the group, Add
Assets to the group, Clear All Assets from the group, Remove Selected Assets from the group or Delete the
group. If the user is not the owner of the group, a message will display at the bottom of the Edit Group
window and the various edit buttons will not be active.
Edit Group
The Edit Group feature allows the owner of the group to modify the name and priority of the group, as well as
choose whether the group can be used for Scheduling purposes.
1. Make the necessary changes to the group name, group use, and priority
2. Assets are deleted in the group dashboard (Group List/ Dashboard).
3. Click “Save”.

Assets
Before adding assets to a group, select the assets using one of the 3 options: All Assets, Assets on Map and
Map Selected (see Selecting Multiple Lighting Assets described on page 28). These selection options can be
further filtered by “Status” condition(s).
1. Using the Maps tab, select the assets or zoom/pan to map image to include desired assets.
2. In the Groups tab select the appropriate group.
3. Click “Options”. The Group Options screen appears.
4. In the Assets section, choose the selection method from the first drop down box.
5. To further filter assets by status, ensure the check box beside “Limit by the following status categories”
has a check mark inside it. If you do not wish to filter by status, uncheck the box. To select multiple
statuses, hold down “Ctrl” on your keyboard and left click on each status. To deselect a status, hold down
“Ctrl” and left click on the status.
6. Click “Add”.
7. An alert will appear with the number of items added to the group.
8. Click “Close” on the alert.
9. Assets can be added to an existing group following the same procedure.
Clear Group
To retain the group name, but remove ALL the assets currently included in a group:
1. Click “Clear”
2. An Alert will appear that confirms the number of assets that were removed from the group.
Remove Selected Assets

To remove certain assets from the group, select the assets on the Map tab and then follow instructions below:
1. Click “Delete”
2. An Alert will appear that confirms the number of assets that were removed from the group.
Delete Group
To delete the entire group:
1. Click “Delete”
2. An Alert will appear that tells you the group has been removed.
Group List / Dashboard
From the group list, the user can access a Group Summary (dashboard) view of all the assets within a chosen
group. The user can also access a detailed list of all the assets within a group.
Group Dashboard View – To view the group dashboard, left click on the group name. A group summary
will be generated in the content window. As described in detail in the Dashboard Tab section, the user can
view all the assets with a certain status by left clicking on the number underneath the status.
Left Click on the

number to view all
assets with this
status. (see below)
Left Click on the

group to view the
group summary.
Group Details for given Status

Group Asset List – To view all the assets within a group, RIGHT click on the group you wish to view. A list
of all assets within that group will be generated in the content window. The user can view a specific asset
on the map by left clicking on the MacID.
Delete assets from a Group – To remove an asset from a group, left click on the red circle with white “X”
under the Remove Asset column. Use caution – there is no confirmation message.
Left Click on the

MacID to jump to
the asset in the
map view.
RIGHT Click on the

Left Click on the red
Group name in the
“X” to remove an
group asset list.
asset from a group.
Commanding Groups
From the groups tab, users with Scheduling permission can send immediate OFF and ON commands to all assets
within a Group. A drop down box will appear requiring a command duration in minutes. The command will execute
when the "Submit" button is clicked. Similarly, if a user has dimmable LED fixtures, then the dim level can be set
for an entire group. A drop down box will appear requiring the dim level and duration in minutes. Immediate
commands override events, schedules, and photocontrol commands. At the end of the command duration assets
return to schedules or events in process.
Click on the desired

command, enter # of
minutes and click Submit

Scheduling Tab
Overview
The scheduling tab displays a monthly calendar. Weekly Schedules and daily Events can be set to a group in the
Scheduling tab.
Weekly Schedules are programmed in weekly increments and run Monday through Sunday . Weekend (Saturday
and Sunday) schedules can be different from weekday (Monday-Friday) schedules. Weekly Schedules can include
on/off controls based on photocontrol operation, specific times, or diurnal clock (sunrise-sunset) settings. Daily
Events for special activities can also be set. These daily Event schedules override any set weekly Schedules or
photocontrol operations.
Schedules and Events may be applied to one or more groups designated for scheduling and/or events. Any active
Schedules and Events are displayed on the calendar for each group.
New and modified weekly Schedules are communicated to the assets at 10:00 PM local time on the day created or
modified. A total of three attempts will be made to send the schedule to all nodes in the group. The schedule or
event command will continue to be sent each night until all nodes have acknowledged receipt of the schedule. The
results of the schedule release are updated and posted on the portal. Results are accessed by clicking on the blue
magnifying glass shown below.
Event commands are communicated to the assets two hours before the event starts and must be posted prior to
that time.
The calendar schedule is
Groups created from
separated into Weekday and
the Groups tab.
Weekend operation.
Click on this icon to

view the results of the
issued Schedule.
Jump feature allows user

to quickly advance to a Weekly Calendar Bar Daily Event
different month.
Manage Schedules Manage Events

Group Priorities
Assets may be assigned to multiple groups to provide reporting and control flexibility. The ROAM enabled nodes
store one recurring schedule with a maximum of 4 commands per day and one event with a maximum of 8
commands in one day. To avoid applying more than one schedule or event to an asset on any one day, the groups
must include a priority level. If an asset resides in two or more groups and has multiple schedules or events
applied, then the asset will receive the schedule and/or event applied to the highest priority group.
Example: MacID # 102A3 is in each of three groups. Two groups have schedules applied and two groups have
events scheduled on Thursday.
Group A Priority 5 Schedule 1 “Security” (on dusk to dawn)
Group B Priority 100 ( no schedule – normal photocontrol) Event 1 on 6:00 PM -2:00 AM
Group C Priority 150 Schedule 3 Energy saving (off after midnight) Event 2 on 7:00 PM – 11:00 PM
MacID 102A3 will receive the Group A Schedule and the Group B Event based on the priorities.
ROAM immediately examines changes to the grouping, priorities, and commands. Recurring schedules are updated
at 10:00 PM on the day of a change, so the schedule will be effective the following day. Events are communicated
to the assets approximately 2 hours before the event start time. Changes to events in process are communicated
immediately.
Manage Schedules
Weekly Schedules are created and modified by selecting the Manage Schedules button. Schedules are scheduled
actions issued for one week at a time beginning on Monday and ending on Sunday. The week can have a different
set of actions for weekday and weekend operation. Weekday and weekend actions are saved under the same
Schedule name. Schedules can occur for one week only or for a date range.
Owner
Information
Existing
Schedules Edit Actions
Weekday/Weekend
Dimming Actions
Weekday/Weekend
On/Off Actions

• Schedules Pane – All saved schedules are listed in the Schedules pane on the left side of the Manage
Schedules window.
• Schedule Details Pane – The details pane allows the user to Save Changes to Schedule Name or Delete the
Schedule, plus shows who created the schedule and the last date modified.
• On/Off Pane – Displays the actions that are currently included in the schedule.
o Actions must be entered separately for weekdays and weekends.
o Up to four (4) daily actions may be set for both weekdays and weekends. Weekday and weekend
actions must be entered separately by selecting the Add Action button for Weekday or Weekend
in the On/Off Pane.
o Add Action – The action window pop-up allows a user to set the operation of the lamp to On, Off
or Normal Operation (photocontrol operation) at a specific time of day.
Action window pop-up
Start time entered

using military time
o Unless the Diurnal Clock (Offset based on local Sunrise/Sunset times) is used, the start time of
the action should be entered in military time format.
o To use a diurnal clock, select the checkbox. A diurnal schedule is utilized by applying an offset to
the sunrise and sunset times for the geographic location for the user. If a location observes
Daylight Savings Time, the schedule will account for the change. Each week, a schedule will be
sent to the nodes reflecting the average time (Thursday) of sunrise/sunset for that week.
Diurnal clock uses

offset time from
sunrise or sunset
• Dimming Pane – If a customer has dimmable LED fixtures, the user may include up to four (4) dim actions
in a schedule. These four (4) actions are independent of the on/off actions for a schedule. The dim start
time is set as described above for the On/Off actions, with the exception that a dim level from 0-100% of
full output is entered.
Dim Level is
entered here.

Create a New Schedule
1. Click Manage Schedules.
2. Click New Schedule.
3. Enter name for the schedule, click Save.
4. Click Add Action in the Weekday pane.
5. Type in a time (in hh:mm format) for the action to begin or offset (diurnal setting).
6. Choose appropriate action (Turn On, Turn Off or Normal Operations).
7. Click Save to add the action to the schedule.
8. Continue to program up to 4 On/Off actions for weekday schedule.
9. Click Add Action in the Dimming Weekend pane.
10. Type in a time (in hh:mm format) for the dimming action to begin or offset (diurnal setting).
11. Choose appropriate dim level.
13. Continue to program up to 4 Dimming actions for weekday schedule.
14. Repeat procedure for adding On/Off and Dimming actions for the weekend schedule.
15. Click Close at top right of window.
Edit Existing Schedule

1. Click on Manage Schedules.
2. Select schedule to be edited.
3. Click the pencil icon beside the action that needs to be edited.
4. The user can either modify the time or action or delete the action entirely.
5. Click Save when completed.
6. Click on Close at top right of window.
Delete an Existing Schedule

1. Click Manage Schedules.
2. Select a schedule to delete.
3. Click on Delete Schedule.
4. Click Yes to confirm deletion.

Manage Events
Daily Events are created and modified by selecting the Manage Events button. Events are scheduled actions for a
day. Events can occur for one day only, consecutive days in a date range or as a weekly occurrence for a date
range.
Owner
Information
Dimming Actions
On/Off Actions
Saved Events
Edit Actions
Add Action
Button
• Events Pane – All saved events are listed in the Events pane on the left side of the Manage Events
window.
• Details Pane – The details pane allows the user to Save Changes to Event Name or Delete the Event, plus
shows who created the event and the last date modified.
• On/Off Pane– Displays the actions that are currently included in the event.
o Up to eight (8) actions may be set per event.
o Add Action – The action window pop-up allows a user to set the operation of the lamp to On or
Off at a specific time of day for a given duration.
Action window pop-up
Start/Stop times entered

using military time
o Unless the Diurnal Clock (Offset based on local Sunrise/Sunset times) is used, the start time of
the action should be entered in military time format.
o To use a diurnal clock, select the checkbox. A diurnal schedule is utilized by applying an offset to
the sunrise and sunset times for the geographic location for the user. If a location observes
Daylight Savings Time, the schedule will account for the change. Each week, a schedule will be
sent to the nodes reflecting the average time (Thursday) of sunrise/sunset for that week.

• Dimming Pane – If a customer has dimmable LED fixtures, the user may include up to eight (8) dim actions
in an event. These eight (8) actions are independent of the on/off actions for an event. The dim start and
end times are set as described above for the On/Off actions, with the exception that a dim level from 0-
100% of full output is entered.
Dim Level is
entered here.
Create New Event

1. Click Manage Events
2. Click New Event.
3. Enter name for the event, click Save.
4. Click Add Action in the On/Off Pane.
5. Type in a time (in hh:mm format) for the action to begin or offset (diurnal setting).
6. Type in a time (in hh:mm format) for the action to end or offset (diurnal setting).
7. Choose appropriate action (Turn On or Turn Off).
9. Continue to program up to 8 On/Off actions for Event.
10. Click Add Action in the Dimming Weekend pane.
11. Type in a time (in hh:mm format) for the dimming action to begin or offset (diurnal setting).
12. Type in a time (in hh:mm format) for the dimming action to end or offset (diurnal setting).
13. Choose appropriate dim level.
15. Continue to program up to 8 dim level actions for Event.
16. Click Save Changes.
Edit Existing Event

1. Click Manage Events.
2. Select the event.
3. Edit commands and times.
4. Click Save changes.
Delete an Existing Event

1. Click Manage Events.
2. Select the event.
3. Click Delete Event.

Adding/Editing Weekly Schedules and Daily Events to the Calendar
Single Week Schedule
The schedule will only be applied for week selected.
1. Click on the Scheduling tab.
2. Select the Group to apply a schedule to.
3. Right click on the schedule bar in the week the schedule will be applied.
4. Select the schedule to apply.
5. Confirm weekday and weekend details.
6. Select the Single Week option .
7. Click OK to save.
1.
3.
2.
5.
4.
6.
7.

Date Range Schedule
Apply a schedule for multiple weeks to matching schedules or all schedules within the date range.
3. Right click on the schedule bar in the week the schedule will be applied.
4. Select the schedule to apply.
5. Confirm weekday and weekend details.
6. Select the Date Range option.
7. Click on the first calendar button for the Date Range.
8. On the pop-up calendar, click on a date in the desired week the schedule should begin.
Note: Monday is the beginning of the week, NOT Sunday. i.e. If you choose Sunday May 10,
the beginning of the week will be Monday May 4 and the end will be Sunday May 10.
9. Repeat for the ending week.
10. Select a Replacement Option
o Matching Schedules Only – This option will change all schedules (within the date
ranges chosen) that are the same as the “Current Schedule” to the New Schedule.
o All Schedules – This option will change all schedules (within the date ranges chosen)
to the New Schedule regardless of the current schedule.
11. Click Save.
1.
3.
2.
8.
5.
4.
10.
6. 7&9.
11.

Single Day Event
The event will only be applied for date selected.
1. Click on the Scheduling tab
2. Select the Group to apply an event to. .
3. Right click on the desired date (in the calendar) the event will take place. Be sure to click in
the empty space outside of the weekly calendar bar.
4. Select the event to apply.
5. Confirm the event details
6. Select the Single Day option.
7. Click OK to save.
1.
3.
2.
5.
4.
7.
6.

Date Range Event
An event can be scheduled to occur every day within a selected range or on the same day on a weekly
basis.
3. Right click on any date on the calendar, as the date range will be entered later. Be sure to
click in the empty space outside of the weekly calendar bar.
4. Select the event to apply.
5. Confirm the event details.
6. Select the Date Range option.
7. Click on the first calendar button for the Date Range.
8. On the pop-up calendar, click on the date the event should begin.
9. Repeat for the ending date.
10. Select an Option
a. If choosing “All days in the date range”, all days within the dates chosen will have
the event scheduled.
b. If choosing “Weekly Occurrence”, the same day of the week will have the event
scheduled within the dates chosen.
11. Click Save.
1.
3.
2.
5.
8.
6. 4.
7&9. 10.
11.

Removing an applied Schedule or Event
If the desired result is to return the group of nodes back to photocontrol operation for a specific period of
time, then the -None- schedule or event should be added to the desired day(s) or week(s) as described above.
Viewing Results of Weekly Schedule Communication

Left click on the blue Schedule Command Results Icon to display a breakdown of the communication results
for that week. If the icon is not shown for that week, the schedule was not modified or sent out to any nodes
for that particular week.
Schedule Command
Results Icon
Command Results
Clicking on the numbers in the

columns will bring up a detailed list of
light assets currently in that category
(See Command Results Detail below)
The quantity in the Not Communicating category is to be expected, as these are nodes that we have lost
communication with due to loss of power, etc. Any nodes in the Not Responding Category should be
evaluated further to find out why they did not receive the command.

Command Results Detail
After clicking on a number in a column on the Command Results, a list of light assets in that specific
category will appear, along with that light asset’s most recent status. Below is an example of the data
available from the Command Details.

Work Order Management Tab
General Functionality
The Work Order Management Tab gives the user the ability to manage their lighting system by generating work
order tickets for assets needing repair, assigning the tickets to specific crews and tracking the ticket through
completion. Work orders can be assigned to individual assets or groups of assets, depending upon the problem
displayed or specific needs of the customer. The Work Order Management Tab has three sub-tabs: Dashboard,
Create and Manage, to assist in managing the work orders.

Work Order Dashboard
The dashboard provides a visual summary of the total number of open work orders and a breakdown of their age.
This dashboard can be exported to Excel, PDF or XML.
Work Order Dashboard Detail

By double-clicking on a number in the column on the dashboard, pie charts are displayed for the
breakdown of these work orders in that specific category. The top pie chart sorts by the different Queue
names, if the Queued column is selected, or by crews, if Assigned or Dispatched is selected. The bottom
chart shows the age of the work orders in the column chosen.

Creating Work Orders
The Create sub-tab is one of several ways to create a work order. Work orders can be generated through just
about every tab, including Dashboard, Maps, Reporting, History, and Groups. With the exception of the Maps tab,
the method of creating work orders is nearly the same. Work orders can be created for individual assets or groups
of assets, depending on the apparent problem or the need of the customer.
Create Sub-Tab
By choosing the Create sub-tab under Work Order, the user can generate a list of assets to create a work
order for. The user can filter the list based on all assets, assets on the map or a specific device identifier,
then further filter by the diagnostic condition, if required. After the appropriate assets have been chosen,
the user should select the refresh button to generate the list of assets that meet the chosen criteria. After
placing check marks beside the assets the user wants to create work orders on, the“Go” button should be
selected to create the work order(s). Any asset that has a “View/Select” icon ( ) in the select column
beside it already has a work order created for it. ROAM will only allow one Work Order per asset. Clicking
on the “View/Select” icon will allow the user to view the work order ticket that is currently open for that
asset.

Dashboard, Reporting, History, and Groups Selection
With any of these tabs, a list can be generated for a given set of conditions. Once the list is displayed, the
user may place a check beside the specific assets that they wish to create a work order for and then select
the “Create Work Orders” to begin creating the work order(s). This will bring you to the same screen as
the Create sub-tab in Work Order.
Map Tab – Single or Box Band Selection
To select a single asset, right click on desired node and choose “Create Work Order”. To select a group of
light assets on the map, click the left mouse button & drag the mouse around the light assets you wish to
select, forming a band. Once banded, the selected light assets will display with a thumbtack. Additional
assets can be added or deleted by repeating the box band procedure. Once all of the assets have been
selected, right click on one of the selected assets and choose “Create Work Order” to begin creating the
work order(s). This will bring you to the same screen as the Create sub-tab in Work Order.

Clicking on “Go”, will bring up the following Work Order screen. This step actually creates the Work Order
ticket. On this screen, the MacID’s of the selected items are displayed, along with fields that need to be
filled in. The Work Order Number can be user defined or automatically generated. If you wish ROAM to
automatically generate a sequential number, leave this field blank. The Work Order can be “Queued”,”
Assigned” or “Dispatched” during this process. Any additional changes will be made to the Work Order
from the Manage sub-Tab. Requests to add, delete or modify Queue’s and Crew’s should be sent to the
ROAM technical support team.

Manage
Once a Work Order ticket has been created, any manual updates to the Work Order ticket or individual items
should be handled through the Manage sub-tab. Any changes made using a handheld device will automatically
update the system once the data has been synchronized.
In the Manage sub-tab, work orders can be viewed based on their status. A Work Order can have the following
statuses; Queued, Assigned, Dispatched and Closed. Individual Work Order Items within a Work Order will only
have a status when the Work Order is Dispatched. These statuses include Pending, Complete, Could Not Repair,
Confirmed, Can’t Confirm and On Hold. A list of work orders in any given status can be viewed by choosing the
desired status, date range, crew and/or queue and then clicking on “Submit”. If you only wish to review “Past Due”
items, place a check in the Past Due box under Dates. The date used for the Begin Date and End Date refers to the
date the work order was created.
Once the Work Order has been assigned to a crew, a

Work Order Ticket should be printed for each Work
Order item using the View and Print icon. This ticket
will print a barcode at the top that will be used in
conjunction with the handheld device to complete
the work order in the field. For the barcode to print
properly, the user must load the Code128 barcode
font on any computer that will be generating Work
Order tickets. This font can be obtained by
contacting ROAM technical services. Work Order
tickets should be printed with a quality printer to
ensure the handheld device will be able to read the
bar code.

ROAM Technical Support
For any questions or comments about this user guide, please contact ROAM Technical Support.
E-mail:
support@roamservices.net
Phone:
(770) 860-3371


ROAM Portal User Guide: Revised: January 14, 2011

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

ROAM Portal User Guide: Revised: January 14, 2011

Загружено:

Авторское право:

Доступные форматы

ROAM Portal User Guide

ROAM Portal User Guide V2.3.1.doc 2

ROAM Portal User Guide V2.3.1.doc 3

1. Go to Tools on the menu bar

ROAM Portal User Guide V2.3.1.doc 4

Standard Node Decorative Node

Last 8 digits of MacID. Full

ROAM Portal User Guide V2.3.1.doc 5

Operational With Issues

ROAM Portal User Guide V2.3.1.doc 6

Reporting - Status exception reporting based on date range options

History - Historical light asset performance and detail information

Quick Select Buttons:

ROAM Portal User Guide V2.3.1.doc 7

Single Day Dashboard

Clicking on the numbers in the columns will bring up a detailed list of

ROAM Portal User Guide V2.3.1.doc 8

Date Range Dashboard

ROAM Portal User Guide V2.3.1.doc 9

City, State and Zip can be removed from

Status for last seven days

Status Code displayed, along with

ROAM Portal User Guide V2.3.1.doc 10

ROAM Portal User Guide V2.3.1.doc 11

Map Panning & Centering

7. Clear 8. Show Group

1. Zoom – Allows user to control zoom level inside the content

ROAM Portal User Guide V2.3.1.doc 12

After selecting Bookmark, a pop-up box will appear

Selecting New Bookmark allows user to create a

After selecting Show Counts, a pop-up box

Select Close to cancel the asset count

7. Clear – Allows users to clear any current asset selections.

ROAM Portal User Guide V2.3.1.doc 13

9. Command – Displays recent command history on selected lights.

After selecting command, a pop-

Commands can be deleted from

After selecting Search, a pop-up box

Select Close to cancel the search

After selecting the Profile Editor, a pop-up box

Click Save to save the changes or Cancel to

ROAM Portal User Guide V2.3.1.doc 14

Control Window & Filters

Control Window Filters selected determines

ROAM Portal User Guide V2.3.1.doc 15

Diagnostic Filter (current filter will display blue check marks)

Mouse Over Definitions will display a definition of the diagnostic condition

Show Gateways Only Filter

ROAM Portal User Guide V2.3.1.doc 16

Diagnostic / Malfunction Icons for DCMs

ANSI Lamp Wattage Table

ANSI Lamp Wattage

ROAM Portal User Guide V2.3.1.doc 17

Historical Operation Status Filter Selected

Status Conditions to choose from

Clicking Select Date will display the

Only assets that were reporting an

ROAM Portal User Guide V2.3.1.doc 18

Work Order Tracking Filter Enabled

Work Order Management Filter Enabled

Work Order Types 1, 2 and 3, Work

Work Order Statuses: Assigned,

Light Asset has a work order and priority flag