Products View
A DMS Product is a container for properties and file Bundles common to all the Devices activated to the Product.
After creating a DMS Product, file Bundles can be added to the product. A Bundle represents a version of the Product. When a Device is activated to the Product, it can OTA a software Bundle available for the Product. Device activation is authorized on a per user basis. There is no limit on the number of Devices activated to a Product.
Products that are owned or managed by you appear in the Products view.
You can limit the list of Products displayed with the filters and categeories at the top of the page.
There are two ways to create Products depending on which edition of ZentriOS you plan to use.
If your application runs on an external host and connects to the ZentriOS Command API via a serial or wireless interface, use the DMS to create a product and to upload firmware bundles ready for deployment to devices.
If you plan to write a custom application using the ZentriOS SDK, use the SDK to create a Product and upload your application and firmware Bundle to the DMS.
Creating a Product
With the Products tab in view, click Create Product to get started.
Enter a Product Title and Code of your choice, then select the ZentriOS hardware platform upon which the Product is based. Finally, pick the edition (flavor) of ZentriOS that will be used with the product. The default edition is ZentriOS-W (base), however it is also possible to create a product that uses the ZAP edition (e.g. ZentriOS-WZ). The ZentriOS SDK must be used to upload firmware bundles for products that use a ZAP edition.
A Product can also be created using the SDK. See ZentriOS-WZ SDK, Releasing Apps to the DMS. The SDK communicates with the DMS and adds a Bundle to the DMS with the appropriate release tag. Immediately after completing the SDK Release upload, the Product appears in the DMS on the products view.
Showing Product Detail
To drill into a Product, select the Product in the Product list.
The Product panel at the top of the page shows a summary of Product information.
The Bundle panel at the bottom left shows a list of versioned firmware Bundles.
The Bundle detail panel at the bottom right shows the details of the selected Bundle.
Editing Product Details
To edit a Product, press the Edit button in the top-right of the summary panel.
Editing allows the following information about the product to be updated:
- Title. Human readable title for the product.
- Product Code. Unique code for the Product. The prefix for the Product code is the owner ID. When a Product is in development, this is the User ID for the product creator. When a product is in production, the product belongs to a Customer and the prefix is the Customer ID.
- State: Published/Archive. Products that are no longer in use may be archived. When a Product is archived, Devices already activated to the Product can still access firmware and assets that belong to the Product. However, new Devices are not allowed to activate to the Product.
- Product Description. Human readable Product description.
- Meta Data. Field for storage of custom Product meta-data.
Select the Save button to save changes, or the Cancel button to discard changes.
WARNING! Changing the Product impacts EVERY Device activated to the Product!
To change the Product image, click the image.
Archiving a Product
To remove a published Product, archive the Product. Archiving a product prevents devices activating to it, but leaves it available for devices already activated to it. Products cannot be completely removed.
- Open the Product Detail page
- Press the Edit button
- Under the State heading, press the Archive button
- Press the Save button
Once the Product is archived it no longer appears in the product listing.
Creating a Bundle
Click the Create Bundle button in the Bundle List panel.
In the Bundle Detail panel, select a firmware version, specify a Bundle version, e.g. 0.0.0.1
, then click Create.
Now in the Bundle Detail you can drag and drop a file to upload.
After specifying file details, click Upload to upload the file to the bundle.
Copying a Bundle
You can copy a Bundle from an existing product. First create a new bundle, then in the Bundle Detail panel choose Copy Bundle from Product, then select the product and Bundle.
Cloning an Existing Bundle
You can clone an existing Bundle, then edit the clone Bundle to create the next version.
In the Bundle list, select the Bundle to clone.
Then press Clone
in the Clone this Bundle
section of the Bundle detail panel. You can choose the version or allow the DMS to automatically increment the source Bundle version.
Editing a Product Bundle
To edit the release state of a Product Bundle, select the Bundle then select the Edit button.
Bundles have two properties that can be edited, State and Tag.
The State property controls the availability of firmware, there are four options:
- Preview. The Bundle is only visible to administrators of the Product.
- Published. The Bundle is available for general use by Ddevices activated to the Product.
- Archive. The Bundle is deprecated and not intended for general use. Any attempt by a device to OTA to the Bundle will fail.
- Trash. The Bundle is no longer available for use.
The Tag property specifies the release maturity of firmware. Options are:
- None. The maturity of the Bundle is unspecified.
- Alpha. The Bundle is an early release and is known to contain bugs or deficiencies.
- Beta. The Bundle is a pre-production beta release and may contain bugs or deficiencies.
- Release. The Bundle is released for production. Any known bugs or deficiencies are documented with the release.
Devices that are tagged as alpha, beta or release receive Bundles with the corresponding tag if available. See Devices, Tagging Device.
Select the Save button to save changes, or the Cancel button to discard changes.
WARNING! Changing the default firmware Bundle assigned to a product impacts EVERY Device activated to the Product!
Publishing a Product Bundle
Open the Product details page for the Product.
Select the desired release bundle in the Bundles list pane at the left of the Product detail page.
In the Bundle detail pane at the bottom right, set the State
property of the Bundle to published
.
Tagging Bundle Release Type
Select the Product in the Products page to open the Product detail page.
Select the desired Bundle in the Bundles list pane at the left of the Product detail page.
In the Bundle detail pane at the bottom right, set the Tag
property of the release Bundle to alpha
, beta
or release
, depending on the type of release.
Adding a User
The DMS allows for development collaboration, with multiple users having different roles in relation to a product.
To add a User, select the product Users panel.
Specify the User email and role, and click Invite.
The DMS sends an email to the user, who can then respond by setting up a user account. The new user is added to the product, with permissions depending on the role.
Roles are:
- Admin: full control
- Edit: edit permissions for Product and Bundle details
- View: the user can see but not edit the Product and Bundles
When you publish a Product Bundle, users can see the Product in DMS Product lists, and activate their Devices to the Product. They can then OTA the Product Bundle version for testing.
Creating a Product Connector
A Product Connector sends product data to a specified cloud endpoint.
Choose the Product Connectors tab, click Create Connector
, and add details.
Creating a Product Asset
An Asset is a file in the Cloud File System (CloudFS), associated with the Product. All Devices activated to the Product can download Product Assets. Assets provide a way to manage Product configuration, independently of the Product Bundle.
Select the Product Assets panel. Drag a file onto the Asset detail panel target area.
Then click Upload
to upload the file to the CloudFS.
Viewing Product Logs
Select the Product Logs panel.
The display shows a list of log events associated with the Product.
Viewing Product Users
Select the Product Users panel.
The display shows a list of Users with permissions related to the Product.
Viewing Product Devices
Select the Product Devices panel.
The display shows a list of Devices activated to the Product.
Creating an Activation Token
For small production runs, you can create an activation token, then use the token to claim devices and activate them to your product.
An activation token can be created only for a production product.
Log into the DMS, select your product, and click Request Activation Token
.
Specify the number of devices to activate to the product.
Click Purchase Activation Token.
The new token is listed in the Tokens panel.
To use the activation token, see Production Workflow, Use an Activation Token.