The ItemSense Management Console (IMC) app runs on the ItemSense Server and is accessed with a web browser. The ItemSense Management Console provides access to the administration, configuration and data query APIs of an ItemSense instance. This allows you to define and configure the RAIN RFID gateways to use with ItemSense, in addition to defining and configuring the zone maps, recipes and jobs that are required in order to start an ItemSense data collection session. Once a data collection session is underway, the IMC also provides the means of viewing the resulting item data.
When you run the ItemSense Management Console for the first time, a wizard walks you through the necessary steps to configure and confirm an ItemSense installation. After the wizard completes, the ItemSense Management Console will be ready to create reader configurations, zones, recipes, and run jobs.
The following browsers are currently supported:
The following steps must be completed before provisioning ItemSense:
Note: The IMC wizard will only execute on the first login.
If you are using a docker-based installation (2016r6 and later), the server IP address is the IP address of the machine on which you installed ItemSense.
If you are using an OVA-based installation, the server displays the URL of the ItemSense Management Console below the text, "ItemSense appliance running. Please connect your web browser to the address below to configure the appliance:".
To connect to the ItemSense Management Console, type
http://<server IP>:3010 into the address line of a web browser and press Enter.
ItemSense Instance ID and regulatory region page appears. When you requested your ItemSense instance, you should have been provided with an ItemSense Instance ID. This id will most likely be in the form of a UUID (
123e4567-e89b-12d3-a456-426655440000). However, some customers may have an Instance ID in the form
IS-XXXXXX. Both formats are acceptable. If you do not know your Instance ID, please contact email@example.com.
Paste your Instance ID into the field labeled
Please enter your Instance ID. Select a regulatory region in the
Regulatory region drop down.
SUBMIT button to continue.
It will take a few seconds for your ItemSense instance to register itself. Once this is complete, the
Log in screen will appear. Enter the
Password of the ItemSense Server administrator. By default, the ItemSense Server administrator has a username of "admin" with the password of "admindefault". Click the
LOG IN button.
The first step is to change the administrator password. This step is optional, but recommended.
Enter the new admin password into
New Password and
Confirm New Password fields.
NEXT STEP to continue to the next step.
The next step is to create a facility.
Create a facility page will appear with the text, "Please create at least one facility before continuing." Click
CREATE A FACILITY.
Enter a facility name in the
New facility name field. If you want this facility to be the default, put a check mark in the
Set as current facility check box. Click the
CREATE NEW FACILITY button.
A spinner page may briefly appear with the text,
Creating new facility.
After the facility has been created within ItemSense, the
Facilities page will reappear with the text, "You have 1 valid facility defined." If you want to create more facilities, click the
CREATE MORE button and follow the prompts. When you have created all the facilities you want to create now, click the
NEXT STEP button.
In many ItemSense installations the RAIN RFID Gateways that will be used will be on a different network subnet than the instance of ItemSense being deployed. In the Configure Networking section you can define any subnets on which RAIN RFID Gateways reside so that the ItemSense Management Console can scan the networks in order to discover which Gateways are connected, helping to streamline the configuration process.
In order to Define a new subnet it will be necessary to know the IP Address of one of the target RAIN RFID Gateways. Enter a name for the subnet in the
Name field and the IP Address of the target reader in the
IP Address field. Clicking the
VERIFY link will then ensure that a network connection can be established to this device. If it is possible for a network connection to be established with the selected Gateway then the
ADD NETWORK button becomes active and the subnet can be added to the list of networks to scan by hitting the
ADD NETWORK button.
Enter a meaningful name for the network to scan in
Name ("REC" is used in this example), and the IP Address of an RAIN RFID gateway within the target subnet in
On clicking the
VERIFY button, IMC will then perform a network query on the specified RAIN RFID gateway to see whether it is accessible, and if it is the
ADD NETWORK button becomes highlighted. A drop down will appear at the top of the page which says the RAIN RFID gateway is "alive and well."
Once the subnet has been verified accessible and the
ADD NETWORK button becomes enabled, click
ADD NETWORK to add the specified subnet to the list of available networks.
NEXT STEP to continue to the next step.
On the "Scan attached networks for readers" page, click the
ItemSense will scan the specified network subnets for compatible Impinj RAIN RFID devices. It does this by forwarding an HTTP request to every possible IP address on the subnet. Valid Impinj RAIN RFID devices will be identified and displayed on the page when the process completes.
The list of RAIN RFID readers is displayed. Select the readers you want to register checking the
Register check box. When you have selected all the readers you want to register, click the
REGISTER SELECTED READERS button to continue.
A dialog appears to verify that you want to register the selected RAIN RFID readers. Click the
Let's do it button to start the registration process, or click
I'll do it later to skip the registration process. The registration process will take about five to ten minutes to complete, and cannot be canceled.
The registration process will install and configure the Reader Agent on the selected readers. Currently, the Reader Agent will allow the readers to report health information to the system. In future releases it will enable additional functionality.
If you click
Let's do it, a spinner page appears with the text, "Registering readers with ItemSense..."
After the readers are registered, the ItemSense Management Console will configure the registered readers.
ItemSense will install the Reader Agent on each reader that you selected on the previous screen. The status of each reader being updated will update as the process continues.
Once the Reader Agent install process has completed, ItemSense displays, "Reader registration completed successfully." Click the
GO TO READER DEFINITIONS button to continue.
The ItemSense Management Console is now set up and ready to run a test job.
GO TO DASHBOARD.
The health status of the reader is displayed in the top right hand corner of the reader definition. The overall reader state can be one of:
In addition, the details of the health of the reader is viewed by clicking on the 'View Details' link. This shows the following health status of the reader:
If there are no conditions affecting the health of the reader, then each of these conditions shows HEALTHY.
These categories show WARNING when a condition that affects reader health has occurred at a low enough frequency that it is not considered an error.
And these categories show FAILED when a condition that affects reader health has occurred at a higher frequency.
The status returns to healthy in the absence of conditions affecting reader health being reported to ItemSense
Sometimes it may be necessary to re-register a reader if for some reason it loses contact with ItemSense. Re-registering a reader can also be done as a troubleshooting step if the reader in question is displaying a bad health status that has not resolved for some time.
To re-register a reader:
Readers that have an "unhealthy" status will appear towards the top of the reader list:
The reader will be highlighted with some guidance text indicating that it will be re-registered if selected.
To continue with re-registration, just select the desired reader and click
Register Selected Readers.
After the reader is re-registered, it may take up to ten minutes for the reader to show up as "healthy" on the ItemSense web UI and health API endpoints. This is because ItemSense must see the reader in a healthy state for a certain period of time before the reader can be considered fully "healthy" again.
To update the firmware on the readers, go to the Administration area:
Click on the 'Firmware' tab: