VIPS Logo

VIPSLogic

Tor-Einar Skog, NIBIO

Last update: 2022-01-05

Overview

VIPSLogic is the administration and business logic system of VIPS. Its main functionalities are:

  • Batch running of models
  • Caching/storing results from batch runs
  • Database of field pest observations
  • Management of organizations, users, farmer's fields, crops, pests and weather data sources
  • Messaging / subscription services
  • Web services to support VIPS's own public web pages and 3rd party clients

No models are deployed in VIPSLogic. It depends on web services from VIPSCore/VIPSCoreManager to run the models. However, for each model available in the VIPSCore/VIPSCoreManager system VIPSLogic needs a preprocessor to compile the model specific input data.

VIPSLogic is the source of data for most clients, including VIPSWeb, the standard public web page for a VIPS system.

How VIPSLogic fits into the whole VIPS architecture

VIPSLogic is a part of the VIPS platform for automatic pest prediction

Technical description

Requirements

  • Operating system: Ubuntu Linux >= 18.0.4
  • Database: PostgreSQL >= 10 + PostGIS >= 2.4
  • Java: OpenJDK >= 11
  • Java EE application server: Wildfly >= 25

License

VIPSLogic is licensed under the GNU Affero GPL v3 license.

Web services

The web services documentation is auto generated using Enunciate, you can read it from this path relative to your VIPSLogic deployment: /public/RESTdocs/apidocs/, for instance here on NIBIO's deployment

Develop and deploy VIPSLogic

Please read the developer documentation

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AuthenticationService
  • /rest/auth/login
  • /rest/auth/uuid
  • POST
  • GET
Authentication services
LogicService
  • /rest/organization
  • /rest/forecastconfigurations/{forecastConfigurationId}
  • /rest/forecastconfigurationsincludeorgs/{organizationId}
  • /rest/forecastresults/{forecastConfigurationId}
  • /rest/model/{modelId}
  • /rest/organization/{organizationId}
  • /rest/organizationforecastconfigurations/{organizationId}
  • /rest/user/deleteme
  • /rest/user/register
  • /rest/forecastresults/{forecastConfigurationId}/csv
  • /rest/forecastresults/{forecastConfigurationId}/{latestDays}
  • /rest/organism/search/latinnames
  • /rest/pois/kml/{organizationId}
  • /rest/weatherstations/kml/{organizationId}
  • /rest/forecastconfigurations/model/{modelId}/{year}
  • /rest/forecastresults/latest/poi/{poiId}
  • /rest/forecastresults/{forecastConfigurationId}/{dateStart}/{dateEnd}
  • /rest/organism/search/localnames/{locale}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
ObservationService
  • /rest/observation/gisobservation
  • /rest/observation/organismsystemupdated
  • /rest/observation/syncobservationfromapp
  • /rest/observation/{observationId}
  • /rest/observation/crop/{organizationId}
  • /rest/observation/filter/{organizationId}
  • /rest/observation/first/{organismId}
  • /rest/observation/gisobservation/{gisId}
  • /rest/observation/list/user
  • /rest/observation/list/{organizationId}
  • /rest/observation/pest/{organizationId}
  • /rest/observation/polygonservices/{organizationId}
  • /rest/observation/broadcast/list/{organizationId}
  • /rest/observation/filter/{organizationId}/geoJSON
  • /rest/observation/list/filter/{organizationId}
  • /rest/observation/list/minimized/user
  • /rest/observation/list/filter/{organizationId}/csv
  • /rest/observation/list/filter/{organizationId}/xlsx
  • POST
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
ObservationTimeSeriesService
  • /rest/observationtimeseries/syncfromapp
  • /rest/observationtimeseries/{observationTimeSeriesId}
  • /rest/observationtimeseries/list/user
  • POST
  • GET
  • GET
POIService
  • /rest/poi
  • /rest/poi/geojson
  • /rest/poi/syncpoifromapp
  • /rest/poi/{pointOfInterestId}
  • /rest/poi/name/{poiName}
  • /rest/poi/organization/{organizationId}
  • /rest/poi/organization/{organizationId}/type/geojson
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET

Data Types

JSON

type description
Cloneable
Comparable
Coordinate
CoordinateSequence
CoordinateSequenceFactory
Country
CropCategory
CropCategoryLocal
CropCategoryLocalPK
CropPest
Envelope
ExternalResource
ExternalResourceType
Feature
FeatureCollection
ForecastConfiguration
ForecastModelConfiguration
ForecastModelConfigurationPK
ForecastResult
ForecastSummary
ForecastSummaryPK
GeoJSON
Geometry
Geometry
GeometryCollection
GeometryFactory
LineString
Message
MessageIllustration
MessageIllustrationCaptionLocale
MessageIllustrationCaptionLocalePK
MessageIllustrationPK
MessageLocale
MessageLocalePK
MessageTag
MessageTagLocale
MessageTagLocalePK
ModelInformation
MultiLineString
MultiPoint
MultiPolygon
Observation
ObservationDataSchema
ObservationDataSchemaPK
ObservationIllustration
ObservationIllustrationPK
ObservationListItem A JSON friendly, public representation of the Observation
ObservationSyncInfo A minimized object for serialization when only sync related information is needed
ObservationTimeSeries
Organism
OrganismExternalResource
OrganismExternalResourcePK
OrganismLocale
OrganismLocalePK
Organization
Point
Point
PointOfInterest
PointOfInterestExternalResource
PointOfInterestExternalResourcePK
PointOfInterestWeatherStation Extension of PointOfInterest, with additional info for weather stations
Polygon
PolygonService
PrecisionModel
Result
Type
VipsCoreInstance
VipsLogicUser
WeatherForecastProvider
WeatherStationDataSource