Return to NI Tools Network Software Requirements
Steps to create Add-on using GWeb Development Software
Requirement | Additional Resources |
Installation | |
Product ships with an installer. | |
The installer includes a EULA which complies with the “Restrictions” and “Application Deployment” sections of the NI Software License Agreement. | http://www.ni.com/legal/license/ |
If the installer requires administrator privileges, this is communicated to the user. | |
The installer documents software and hardware requirements and incompatibilities. | |
The product supports at least the latest Gweb Development Software version. | |
[Recommended] Package either checks for required software or prompts the user to manually check for required software. | |
Activation (if applicable) | |
The add-on is able to be evaluated immediately upon downloading the software. | |
Users are reminded of the remaining trial time or uses. | |
Upon the trial expiring, users are prompted to activate the add-on. | |
The add-on can be activated using appropriate credentials. | |
Activation instructions are documented in the help. | |
Examples and Tutorials | |
The add-on includes examples that demonstrate typical use cases to help the user get started. If examples are not appropriate for the add-on, a step-by-step tutorial should be added to the add-on's documentation. | https://ni.github.io/webvi-examples/ |
Examples should be intuitive to run and any required steps by the user must be documented. | |
Example code is not protected and users can view the source (if applicable). | |
Default values of inputs allow the user to run the example without modification unless documented to the user (e.g. "Specify the required input to get the desired output"). | |
Palettes and Icons | |
Add-on controls palettes either reside in the \Addons category OR under the appropriate palette category(ies) for their products. |
|
VI and palette icons do not contain NI company or product logos. |
|
VI and palette icons contain a similar style or glyph to help users understand the VIs are related. |
|
[Recommended] VI and palette icons use glyphs or images to illustrate the VI's purpose. |
|
API Design |
|
The API uses a consistent terminal design across all VIs (e.g. reference terminals aligned across all VIs) |
|
API VIs contain error terminals on the bottom left and bottom right of the connector pane. |
|
Left-side terminals of API VIs are used for inputs and right-side terminals are used for outputs. |
|
All API VIs contain VI, VI input and output descriptions visible through Context Help. |
|
[Recommended] API VI descriptions contain a link to the API's detailed help |
|
File Structure | |
Files and folders follow a company/product naming convention to ensure namespacing and avoid conflicts with other add-ons. | |
Documentation | |
Add-on contains a help document that is easily accessible from within the product or start menu. | |
The documentation outlines all hardware, software and operating system requirements. | |
The detailed help directs users to the appropriate support channel. Free products may list "not supported". | |
Documentation includes a getting started guide with an example or walkthrough (if applicable). | |
Miscellaneous | |
The product does not include or install any malicious software. | |
There are no unexpected crashes or errors when using the product. | |
There are no memory or processor resource issues when using the product. | |
The product complies with the LabVIEW Tools Network Style Guide. | http://forums.ni.com/docs/DOC-36609 |
It is clear to the user when administrator rights are required for successful use of the add-on. |
|
The product and accompanying documentation are localized in English. |