Validation

From AMTech WikiDocs
Revision as of 10:09, 21 August 2017 by Lianet (Talk | contribs)

Jump to: navigation, search
  • At startup time the M2MBridge validates its configuration with the cloud. If errors are found, the M2MBridge application aborts.
  • To simplify the process of validating the configuration there is an option in the UI to validate a bridge instance.
  • Validations can be performed as creator or follower

Validation requirements :

  • Bridge type must produce crud observations (Check on thing type)
  • Bridge must have observation production configuration
  • Thing instances must exist for types that produce obsevations (this will be shown as an error for creator and as a warning for followers validating bridge templates)
  • All observation types configured to be produced behind the bridge must be published
  • If the user validating the bridge is a follower, it must have actors for all thing types configured to produce observations behind the bridge
  • All thing types configured to produce observations must have at least one observation type that they produce in the config (target things is not required though)
  • Topics in config cannot be empty
  • Topics in config must start with an explicit topic, and may have placeholders only after that (Ex. /topic1/…./#{bridgeId}/…)
  • Topics in config must have a root topic owned by the creator that owns the bridge template (this validation only applies for creators)
  • Bridge instance must be valid for its metadata (and all its links too)
  • All links must be explicitly included in the property bridgeInstances (ex. if a bridge has an instance behind it that is an LLRPReader, all the antennas associated to that reader must be explicitly included in the bridgeInstances as well)
  • Things in the bridgeInstance list cannot be bridge instance of any other bridge

Aggregation validation :

  • There must be at least one thing instance in bridgeInstances for those types in the aggregationTypes
  • If the user performing the validation is a follower, it must have actor for all types in the bridge aggregationTypes
  • Things in the bridge aggregationInstances must be included in the bridgeInstances property
warning if the bridge has no property aggInstances (not via UI)

Network errors :

  • Only one bridge in the network can be “aggregator” for a type (ex. BLEbeaconsScanner)
  • A bridge can not be aggregator and aggregator source of the same type. A bridge is aggregator of the types included in its aggregationTypes, and it is aggregation source of the instances included in its aggregationInstances.
  • A thing type can only be aggregation source of one bridge in the network

Notes:

  • A bridge may have bridge instances whose type is not configured to produce observations (ex. Instances behind the bridge that will only receive command, not send any observation)
  • Upon bridge validation as creator, the bridge observationProduction is shared with the bridge guest tenant and guest users. This will ensure that followers cloning that bridge will have access to the observationProduction

User experience:

  • To validate a single bridge select it at amtechM2mBridge collection:
Validate a bridge
  • To validate multiple bridges select them at amtechM2mBridge collection:
Validate multiple bridges