Skalli/User Guide

Tutorials

How to Implement Skalli Extensions

You can write your own extension. A Skalli extension are all display & application logic elements needed to provide a specific functionality. You can simply bring Skalli to visualise their information.

Find out how to write your extension:

• Five Minutes Tutorial
• Extended Tutorial

Configuration

There are different configuration possibilities for Skalli.

Various configuration settings can be managed via REST API calls. (There is a good Firefox add-in for that: RESTClient (https://addons.mozilla.org/en-US/firefox/addon/9780/)

If you do not know how to obtain the Skalli sources and how to start it, please visit Contributor Guide first.

The Workdir

The working directory of Skalli is the place data is stored.

In the subdir storage persists information like projects,favourites or users.

The workdir can be set via:

1. property workdir in configuration file /skalli.properties
2. system property workdir=<path-to-storage-directory>

If workdir is not set in one of the above described places the default is the current directory.

Using the Local User Store

Skalli is able to use LDAP for user management. If you want to use the local user store you the ldap service has to be disabled.

Check the state of the service org.eclipse.skalli.core.user.ldap using the OSGi console command ls. If the ldap service is Active , disable the service with disable <ID>

Users are stored in the directory <workdir>/storage/User. Each user is persisted in his own XML-Files named <userId>.xml in the directory <workdir>/storage/User

Example for <workdir>/storage/User/ad.xml:

<org.eclipse.skalli.common.User>
  <userId>ad</userId>
  <firstname>Arthur</firstname>
  <lastname>Dent</lastname>
  <email>arthur.dent@milliways.com</email>
  <telephone>+000 314159265</telephone>
  <room>42</room>
  <location>End of the Universe (and then right)</location>
  <department>kitchen</department>
  <company>Milliways - The Restaurant at the End of the Universe</company>
  <sip>sip:arthur.dent@milliways.com</sip>
  <detailsMissing>false</detailsMissing>
</org.eclipse.skalli.common.User>

Note that the userId has to match to the user of your Server (jetty, tomcat).

Configuring Administrator Users

Administrators are allowed to do more than normal users.

Eg. they are allowed to:

• delete/edit projects
• see all error issues

Call the Skalli command admin via OSGI console to list, add or remove administrators:

skalli admin [-list] [-add <admin_id>] [-remove <admin_id>] - maintain set of user with administrative permissions

If you for example want to add the user skalliadmin to the administrators call:

osgi> skalli admin -add skalliadmin

Administrators are persisted in the directory <workdir>/storage/Group.

Terms

[Skalli] Extension	All display & application logic elements needed to provide a specific functionality. You can write your own extensions and bring Skalli to visualise their information.
Info Box	A single box displaying the information of one extension to the user
Project Details Page	The main project page containing the info boxes
View Mode	The project details page without edit forms and without initially visible editing capabilities
Navigation Panel	The list of links on the left hand side (currently of the project details page)
Edit Mode	The forms page when clicking edit in the navigation panel of the project details page