FAQ

Oskari is open source, meaning the source code is available to view, edit, enhance and use free of charge.

The source code for Oskari is open source. It is being kept flexible in order to broaden it with new components, use it with different service platforms and for changing the software libraries if needed.

The UI has multilingual support and there are already multiple languages translated. All source code is being published with MIT/EUPL licenses.

If you don’t want to set up your own Oskari installation, you can build map views with the Published maps functionality in Oskari. This requires an Oskari installation that has enabled the Published map functionality.

If you are registered to the Oskari site you want to use, add the map layers you need to the map and click Published maps. Follow the instructions. You will get and iframe code that you can embed to your web site.

Check access rights. It might be that users with guest-role (most of the people looking at embedded maps) don't have permission to see layers included in the embedded map.

Embedded maps can be tweaked to be in contact with your web site and provide more information to users using code snippets called RPC (Remote Process Call). See the RPC example codes.

You found a bug? Can you repeat it? Yes: file a bug report at GitHub issues.

• Go to: Oskari's GitHub page
• Sign up
• Click New issue button on oskari-documentation repository
• Include helpful information: what Oskari version you used, with what browser and what are the steps to reproduce the error
• Click Submit new issue

You can ask Oskari related issues by sending a query to Oskari user mailing list or chat in Oskari Gitter.

The technical requirements have been listed in the documentation.

We recommend that you see the first two sections of Oskari's documentation (Introduction and Application environment). Then ask if you need assistance!

Oskari is not a software you can set up by just pushing a execute button. It is a comprehensive setup that requires understanding about server side and different software libraries. The setup is also dependant on the operating system and server environment.

If you want to provide improvements to Oskari, here are some steps to do it. See also the documentation.

• Open the Oskari source code in your project. Remember to follow the guidelines and How-to. Share your plans also openly through Oskari Roadmap in GitHub, so other developers know what to you are up to.
• Test and report bugs.
• Discuss and ask support.
• Remember that adding new features to Oskari main development line are discussed and decided by Oskarin PSC. If the developed feature is not suitable for the main development line, it can be added as a Community Plugin.
• Remember to update your plugins and take care that they are compatible with the versioning of the main development line. Optional: Join Joint Development Forum for Oskari and let's activate a joint development project. You'll receive support from the group and National Land Survey of Finland, were the technical support team is ready to tackle your questions and check your source code.
• We also recommend that you join Joint Development Forum for Oskari and we'll activate a joint development project. You'll receive support from the group and National Land Survey of Finland, were the technical support team is ready to tackle your questions and check your source code.

Run mvn -N versions:set -DnewVersion={NEW-VERSION} on oskari-server root. It updates the version for oskari-server/pom.xml and all the maven modules defined in its modules-tag.

Before you can add any map layers to the service, you must have at least one data provider and theme.

Add data provider from Map Layers. Click the + symbol and Add data provider. Give the data provider a name in all the desired languages and a description if needed. Then click Add.

Data providers can be edited when map layers are sorted by Data Provider. Click the pen icon on the right and do the necessary changes. Remember to Save the changes.

Click the Delete button if you want to remove a data provider. There must not be any map layers in the data provider's group for it to be able to be deleted.

Before you can add any map layers to the service, you must have at least one theme and data provider.

Add theme from Map Layers. Click + and Add theme. Give the theme a name in all the desired languages and a description if needed. Finally click the Add button.

Theme can be edited when map layers are sorted by theme. Click the pen icon on the right and do the necessary changes. Remember to Save the changes.

If you want to remove a theme, click Delete. There must not be any map layers in the theme for it to be able to be deleted.

Before adding any map layers there must be at least one data provider and one theme. Look at Data provider and Theme for information.

Open map layers, click the + symbol and choose Add a new map layer. Choose a type for the map layer.

Add the map layer’s API URL and, if necessary, an username and password Choose the version of the interface. For vector data the common version is 1.1.0.

Fill in the unique name of the map layer which comes from the interface. You can add a description in every desired language.

Choose a data provider and theme from Select groups for the map layer.

Clicking the Add a new layer from the same service button opens a list of all the map layers of that same interface. Check that all of the information is correct before adding the map layer.

Opacity and scale are changed in the Visualization tab. Different map layer types have differences in visualization.

Vector type layers can be defined to have a style made in the editor or added with JSON code. The style can be modified for point, line and polygon (area) depending on the map layer. Vector type layers include WFS / OAPIF layers.

Raster type layers include WMS layers. They come from the API usually "as is", meaning that their visualisation cannot usually be changed.

Metadata input can be found in the Additional tab. Oskari displays metadata from a separate metadata page.

A map layer can be edited by clicking the pen icon before its name.

Edit the map layer as you like and finally click Save at the bottom of the window. If you don’t want to keep the changes just close the window by clicking Close at the bottom of the window or X at the top right corner of the window.

If you want to completely delete a map layer, click the Delete button. Sometimes deleting isn't necessary, and you can just remove viewing permissions to the desired map layer from roles other than admin.

Note that someone might be using the map layer in an embedded map. By deleting the layer it will also become unavailable in the embedded map.

In the Users tab you can see a list of all users. This is where you can search for users, modify their information or delete them. When editing the data, you can change the user's nickname, first and last name and email, but these should not be touched without the user's permission/knowledge. This is where roles are added to the users.

Roles

Users are given roles and different roles can be given different permissions to the map layers. The same role can be given to various users, making it possible to have user groups with the same permissions.

The permissions that can be granted to map layers are view, view in an embedded map, publish and download.

In the Roles tab you can create new roles, edit the names of old ones, as well as delete roles. By default, the roles have an admin role or an user role.

Users by role tab show which users has a specific role.

When you have configured a new role click the Add button at the bottom of the window. The changes will not be saved if you click the Close or X buttons. Should there be any pop up windows warning of an error, act accordingly to resolve the issues.

In layer rights, you can update the rights of the roles for each layer. If there are several pages of different layers, it is possible to search for the layer for which you want to update the rights.

In layer monitoring, you can see a list of all levels and their information about ID, name, data provider, type, total screens and incorrect screens. By clicking on the name of the information, you can arrange the information in descending/ascending order. Here you can also edit the level or delete it.

By clicking on the name of the map layer, you can see more detailed information about its openings. Here you can see the number of successful and failed openings, at what time interval these have occurred and the map layer on the map where the error occurred.

Announcements tab shows current, upcoming and outdated announcements together with making new ones.

There are two types of announcements: banner and pop-up. When adding a new announcement, you must specify the time for the announcement and what type of announcement it is. The types are Title only, Title and contents, and Title and external link. Add a title and possible other contents for every language your map service uses.

You can preview, edit or delete announcements from the icons at the right of the window. Remember to click the Save button when you have done the desired changes.