This is an online access manager for all kind of facilities

• Official homepage
• Demo
• JavaDoc

1. License
2. System requirements

• System requirements - server
• System requirements - client
• System requirements - developer

3. Install

• Main
• Plugins

4. Configuration

• In General
• Facilities
• Job Data
• Cronjobs
• Templates
• Mails
• Roles and Rights

A. Links

• [Wiki Pages] (#z-a)

Copyright 2009-2012 by KNURT Systeme (http://www.knurt.de)

Licensed under the Creative Commons License Attribution-NonCommercial-ShareAlike 3.0 Unported;

You may not use the Facility Access Manager except in compliance with the License.

You may obtain a copy of the License at

http://creativecommons.org/licenses/by-nc-sa/3.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Get a commercial license

• Linux
• Java 6 (5 won't work, 7 not tested yet)
• MySQL 5.0.3 or higher (other databases with java support should work as well but are not tested)
• [Apache Tomcat 5.5 or higher] (http://tomcat.apache.org) (other servers should work as well but are not tested)
• [CouchDB 0.10.0 or higher] (http://couchdb.apache.org)

You need the server requirements as described above.

Furthermore:

• [Maven] (http://maven.apache.org)
• [Java-Heinzelmann] (https://github.com/knurtsysteme/java-heinzelmann) See pom.xml to find out which version.
• on couch works [CouchApp] (http://couchapp.org/)
• on css works [less] (http://lesscss.org) running out of the box (without npm).

... and git.

For testing:

• [Firefox] (http://www.mozilla.org/firefox)

JMeter and Molybdenum are shipped with the pom.xml

1. Download the latest version
2. Extract the ZIP-File
3. Copy folder opt/knurt into system folder /opt
4. Ensure tomcat can read all files in /opt/knurt/fam and can write into folder /opt/knurt/fam/files
5. Edit file /opt/knurt/fam/config/fam_global.conf as described there. This is the place where to put in all the database connections.
6. Make sure database- and email-driver jars are in your tomcat lib folder.
7. Create CouchDB-Database (as configured in 5.) and push in the design-document migration/as.json
8. Create SQL-Database (as configured in 5.) and push in the sql-file migration/init.sql
9. Install webapp/fam-core.war to your webapps folder of your server (e.g. /usr/share/tomcat6/webapps)
10. Start up server and application
11. Visit your server-uri. You should see this [http://facility-access-manager.com/fam-core](Demo System) now.
12. Click the Register-Tab and register yourself. You get an email with your username then.
13. Replace the username daoltman with your username in /opt/knurt/fam/config/rolesAndRights.xml to be an admin. Add more admins there by adding the usernames comma seperated.
14. Log in as admin

Hopefully that's it! You can check all configuration parameters under Admin → System Configuration.

What you have done is installing the demo system. What you may want to do is configuring the system with your facilities, booking rules, roles and rights. Go to base Configuration to know how

You can install the system on three different servers: One for the public page, one for protected pages and the third one for admin pages. You can also install it on two servers. The only thing to do is to configure the same public, protected and admin url in /opt/knurt/fam/config/fam_global.conf. The protected and admin area do need contact the same databases.

The core configuration (roles, facilities, booking rules) is made with XML files. XML stands for "Extensible Markup Language" and simply describe data structures.

In practice, XML bean configurations which are part of the spring framework are particularly used. XML bean configurations can be very complex and very powerful. Basically all options of XML bean configurations can be used but basic knowledge of XML is sufficient to configure the application.

For a complete description of options of an XML bean configuration visit the IoC container

A good introduction to XML is offered by Wikipedia

The system supports creating own templates. The one and only template by now uses Velocity. See Templates-Section for more information.

Properties files are an important mean of internationalization when programming. Although the System so far only supports the English language, several texts are stored in properties files.

The use of properties files is basically the key-value coding (key=this is the value). Concerning emails placeholders are used ({0}, {1}, {2} etc.). Furthermore almost all properties files contain comments starting with a pound sign "#".

During the installation you already worked with it!

The preceding description is sufficient to configure the application. Furthermore Wikipedia offers a good introduction to properties files

Some configurations like the terms, the job data or user's responsibilities are made directly in the system and are described there.

Follow the instructions in the file /opt/knurt/fam/config/fam_global.conf. Main settings are for database connections, a hard coded direct access to a full screen booking calendar, the uri to own content (if you like to use own pictures etc), a possibility to use a proxy, the email-server-settings, file-upload settings and so on.

Texts for emails, html header, facilities and logbooks are set in the file /opt/knurt/fam/config/lang.properties.

• /opt/knurt/fam/config/loader.xml Load the configuration files described here. Configure other files if you want to.
• /opt/knurt/fam/config/calendarDefaultViews.xml Is deprecated and will be removed in future releases.
• /opt/knurt/fam/config/mail.xml If you want to have a delay on sending emails.

# the label shown when user choose the facility to book ("I'd like to book ...")
myfoo.label=Nice People to rent
# the label shown when user book one of it ("I'd like to book 1 ...")
label.capacity.myfoo.singular=Person
# the label shown when user book more then one of it ("I'd like to book 2 ...")
label.capacity.myfoo.plural=People

[root@localhost ~]# crontab -l
*\/5 * * * * curl http://www.yourdomain.com/fam-core/exec-cronjob.html

[root@localhost ~]# crontab -l
*\/5 * * * * wget -S http://www.yourdomain.com/fam-core/exec-cronjob.html --no-cookies --no-cache -O -

1. copy file from content_main/[visibility]/[resource].html to custom/[resource]_[visibility]_main.html
2. edit file in custom directory.

example: cp content_main/public/home.html custom/home_public_main.html

1. copy file from content_sub/[resource].html to custom/[resource]_sub.html
2. edit file in custom directory.

example: cp content_sub/register.html custom/register_sub.html

You can configure your web-analytics in the file custom/web-analytics.html.

If you do not want web-analytics, simply kill that file.

In custom/lanuage.xml you can configure other things like your company name or a maintenance message. The main part of this file described page specific texts used by the template.

1. add the page definitions in custom/config.xml and custom/language.xml file
2. copy an existing page <page>...</page> in both files - think, that is self-explaining.
3. create the content file in custom directory like described above.
4. create page specific styles in styles/[name].css.
5. create page specific scripts in scripts/[name].js.

Attention: Styles and scripts are parsed by velocity. You might get difficulties if you are not including your concrete styles. See existing files for more information.

1. copy a file from directory styles or scripts into this directory (without renaming)
2. edit file here
3. files not working are files named "all-....css"

Override style definition concerning all pages in "all-pages-update.css"

1. define letter style letter_style.json
2. define letter structure in letter_booking.json

As you find in the demo json-files, you can use some velocity templates.

1. set configuration in custom/ValidationConfiguration.js
2. do not forget to change the server side definitions in rolesAndRights.xml (bean with id bean2010310903). there is no need to be equal, but all things missed defined in rolesAndRights.xml must be filled in by the user later.

You may want define simple things like "must have a value" up to complex custom validation functions here. See the file for more information.

mylog.label=My Logbook
mylog.description=This is a description of the logbook
mylog.tags=notice,problem,request,bug

role.desc.myrole=This role is my role
role.label.myrole= My Role

• Plugin Development