Requirements, Review and Distribution

Modified on Friday, 24 October 2014 08:18 AM by 156.75.200.91 Categorized as Uncategorized
While the GIS Framework includes components that are expected to apply to a wide range of applications, there are going to be cases where new ones need to be created.  That is, of course, why the Framework supports extensions.  There will undoubtedly be cases where custom extensions to support a given virtual application could be of benefit to others.  Therefore, sharing of customizations is strongly encouraged.

==Is an extension a good candidate for sharing?==
The following criteria should be considered when evaluating an extension for sharing:

====How specific is the component to a particular business use?====

In general, the narrower the scope of an extension and the more tightly coupled it is to specific inputs and outputs, the smaller its potential audience.  For example, if a given component requires a specific data source and does some operations on it to produce a certain type of graph, then its appeal will be limited to others who use that data source and want to produce that graph.  If, however, the component can accept a variety of data sources or produce a variety of data summaries from a given data source, it's a better candidate for sharing.


====Does the extension use proprietary code or services?====

Any dependencies on proprietary code or services that would require licensing by anyone wishing to use the component limit its potential audience.  For instance, a component that uses a commercial library for rendering graphs might require per-server or per-developer licenses.  Where possible, try to avoid the use of such dependencies, or give preference to those with open redistribution.


====Does the extension use limited access services?====

Extensions can be created that access services for various reasons.  If those services have restricted access, then the extension may be effectively useless to anyone else.  To ensure a broader appeal for extensions, either establish a policy for allowing access to the service(s) or, when possible, bundle the service with the extension so those wishing to use the extension can host their own instance of the service as well.


==Provide adequate documentation on configuration and usage==

The framework documentation covers the general aspects of configuring components, commands, etc. with virtual applications.  However, if there are any custom initialization parameters supported by the extension, or configuration options that are not intuitive, please provide ample documentation.  For commands that implement IScriptableCommand, and are therefore accessible via the Javascript API, documentation on the input/output parameters and usage should also be provided.  Finally, a point of contact should be identified, preferably accompanied by a group email account or number so consumers of the extension can provide error details and feedback.  It is not the responsibility of the GIS Framework Team to maintain submitted extensions.


==Submit the extension for review==
Before any extension will be made available for download, it must be reviewed by the GIS Framework Team.  Please note that the code review is not intended to evaluate the quality of the code, but instead to look for any of the following:

* Proprietary dependencies.

* Missing dependencies or documentation.
The GIS Framework Team will attempt to configure the extensions to ensure that the package submitted is complete and contains the necessary documentation to be properly configured.

* Cumbersome or convoluted interactions with the framework.
If something looks indirect or follows odd paths through the Framework's API, it may be indicative of a flaw or shortcoming in the API itself.  The idea here is to identify those cases and make improvements that will simplify the extension and future extensions.

Following a successful review, the extension will be made available at [ThirdPartyExtensions|Third-Party Framework Extensions].

==Inclusion in the Framework==
If the GIS Framework Team, during its review, believes that a given extension could appeal to a wide audience, it may recommend that it be included in the Framework's core set of tools.  Because doing so would bring the extension under the Framework's support umbrella, inclusion would need to be approved by the Functional Steering Committee.  Please note that this does not imply ownership of the extension by the GIS Framework Team, simply that they will participate in its ongoing maintenance and support, that it will be distributed with the Framework itself, and that its documentation will be included with the Framework's documentation.
Meta Keywords:
Meta Description:
Change Comment:
FDOT Wiki

GisFramework¶

Requirements, Review and Distribution
