What is the Cloud Integrations Marketplace?
The Cloud Integrations Marketplace is an online platform for promoting integrated solutions to the entire ecosystem; making your integrations accessible to all downstream end-users, system integrators, and distributors. A beta version of the Marketplace is currently available on Nx Cloud and the Nx Meta Developer Portal.
In this guide, you will be submitting and managing your integration entry through the Nx Meta Developer Portal.
Note: A full version of this guide is available for download at the bottom of this page.
Where do I get started?
You will need to create an Nx Meta Developer account if you don’t already have one. If you already have a Cloud account, log in using your existing credentials.
If you'd like to submit an integration, please fill out the form on Join the Integrations Marketplace. In the email field, use the email associated with the Cloud account you will use to manage your listings; then submit the form. Afterward, a member of the Nx Team will reach out to you through the email you provide to get you started.
How do I submit an integration?
PLEASE READ FIRST
In all the text, images, and video you use in your listing, please avoid using any Nx Witness or Network Optix branding:
- For text, use the branding variables available below the description boxes.
- For creating images and videos, use the Nx Meta desktop client.
- For videos, avoid mentioning Network Optix or its products.
Step 1: Log in to the Nx Meta Developer Portal
Step 2: Open the Administration interface
Visit the Administration interface by clicking on your email address in the top-right corner of the page and then selecting Administration.
Step 3: Create your asset
In the Administration dashboard, under Asset Management, select the + Add on the Assets row to add your asset (integration).
Input your Integration’s name in the Name field. This will simply be the name of the asset in the system. The name that will be shown on the Marketplace will be inputted in a later step. Leave the other fields as is, and select Save or Save and add another if you’re submitting multiple.
Step 4: Edit your integration
On the Edit a Page view (a.k.a. Edit Content) you will find the following links:
- How does it work?
- How to setup?
- Download Files
- Requirements and compatibility
- Version Details
After each step or every time you finish editing a page, press Save draft and Open Preview to save your progress. Then click on Pages in the top breadcrumb bar to return to the Edit a page view.
Step 4a: Editing the Information page
This is the information that appears on your integration's tile on the Marketplace page.
Fill the fields with the relevant information. Use a high-quality, transparent logo (.png).
Make sure that your tile's short description doesn't fade out towards the end (review how it looks on the main Marketplace page).
Example of a good description
Example of a bad description
Step 4b: Editing the How does it Work? page
This is your integration entry's main page. Follow the data fields to add your video and screenshots.
In addition to a description of your integration, please include information on: how your integration works with Nx Witness and which developer tool of Network Optix you used to make the integration.
When we review your entry, we check that your entry:
- has a description that is informative and easy to understand
- uses the branding variables (see READ FIRST section above)
- how your product is integrated with Nx Witness
If your entry doesn't meet these criteria, it will be rejected with feedback on how to improve it.
Step 4c: Editing the How to setup? page
This page should contain accurate instructions on how to set up your integration with Nx Witness. Include any relevant video and screenshots showing the process.
Create a step-by-step overview of the process an integrator/end-user should follow to install and configure the integration with Nx Witness. Make your instructions are clear, detailed, and accurate.
Step 4d: Editing the Support block
Input the fields with support information, including a support email and website where users can contact you for help.
Step 4e: Editing the Download Files block
This page allows you to upload files that will be stored on Nx Cloud and can be downloaded directly from the Integrations Marketplace. Make sure you use the proper categories for the files.
Step 4f: Editing the Requirements & Compatibility block
The information input on the Requirements & Compatibility page describes the version of Nx Witness that your integration is supported on and Supported OS & Platforms, as well as any additional relevant information. We require you, the developer, to test your integration with the latest VMS version.
To find your Nx Witness build number, go to the About page in Nx Witness (press F1 within the client) and find the version number at the top. The build number is the last five digits at the end of the version number.
If your integration has any additional requirements you think are relevant, you may add a custom description under 'Additional Requirements'.
Step 4g: Editing the Version Details page
The information you input on this page outlines the version of your plugin. If you update your plugin, then please update the version number on this page.
Input the version of your integration. Additionally, you may include any update notes in ‘What’s new?’.
Step 5: Submit your integration for review
When all of your integration’s information has been reviewed and edited, visit any page (information, how does it work?, etc) and press the green Submit & Review button.
After you submit your integration, one of our team members will review it and provide any feedback, if needed. It will then either be accepted and visible on the Marketplace or rejected with written feedback, after which you would need to make the necessary edits and re-submit for review.
Step 6: Maintaining your integration
In the future, to modify or update your listing, simply visit the Administration Dashboard page click on Assets and you will find your Integration. Click Edit Content to continue the Edit Pages view. On the Assets page, you should be able to view all the integrations you’ve created.
After your integration is submitted
Depending on the integration, we may request to test it for quality control; this is to ensure a smooth experience for our users and to validate the installation instructions. We may request a copy of the software package or remote access to a demo system with Nx Witness and your integration installed.