Oskari API Documentation

Select bundle

admindown-arrow
cataloguedown-arrow
  • metadata
    Generic functionality to display metadata from a CSW-service
  • metadatasearch
    Provides metadata catalogue search user-interface for an application.
frameworkdown-arrow
  • announcements
    Bundle for displaying announcements made with admin-announcements.
  • Core services
    Provided by the framework
  • layeranalytics
    Map layer problem tracker
  • layerlist
    A layer listing functionality for the geoportal.
  • mydata
    Provides generic container for listing user data and offers other functionalities a way to present user-specific information.
  • Map Publisher 2
    Allows creation of embedded maps
  • RPC
  • Search
    Provides basic search functionality without any UI
  • Selected-featuredata
    Allows infobox opening in new flyout
  • statehandler
    History functionality and state saving.
  • usagetracker
    Pings the server when any of the configured events occur.
mappingdown-arrow
statisticsdown-arrow
  • statsgrid2016
    Statistics data display. This will replace the statsgrid bundle specification when the implementation has the comparable functionalities as the current one. The bundle depends on mapstats-bundle that provides support for statslayer layertype.
uidown-arrow

admin-announcements

Admin bundle for making announcements.

Description

The bundle allows admins to create announcements to be displayed in announcements tab. Admins can optionally also set the announcement to be displayed in a pop-up.

Announcement parameters

These are the parameters you can set for an announcement when creating a new announcement or editing an old one.

Parameter Functionality
TitleTitle of the announcement. (String)
ContentThe body of the announcement. (String)
Starting dateStarting date of the announcement. Announcement won't be displayed until its starting date. This is displayed as "Valid" date selector. (Date)
End dateEnding date of the announcement. Announcement won't be displayed after its ending date. This is displayed as "Valid" date selector. (Date)
ActiveIf toggled on, the announcement will show as a pop-up when users enter the application. The pop-up can be toggled off by the users after they have seen it. (Boolean)

TODO

  • Make Admin-announcements bundle to be a separate tab on the same tile OR make the functionality be similar to admin-layereditor.
  • Tests

Bundle configuration

Frontend has no configuration, but the bundle is usually configured to be shown only to admin users. Configuration is done in oskari-server using oskari-ext.properties.

Dependencies

Dependency Linked from Purpose
Oskari announcements Expects to be present in application setup Oskari's announcements bundle. Uses announcements bundle's services