Open-Source Groupware Thetis: User's Manual

Sysphonic

About Thetis

Setup

Screen Comp.

Common Menus

Admin Menus

Tips

Support

License

Installation Ex.

Menus can be displayed anywhere by clicking outside on the left.

Open-Source Groupware
Thetis User's Manual

Version	Thetis ver.0.9.5
	∧Download

◎ New Features and Improvements of ver.0.9.5

Each of registrant and sanction Users can move and delete Items of decided Workflows now separately.
Copies are automatically distributed to all related Users when Workflows get finally decided so that deletion and movement of the Items come to be done each separately.
Strage location for Attachment files of Items comes to be selectable in file-system in addition to conventional database.

One of Database and File-system (Directory) can be specified as the preservation place of attachment files by the configuration file, and Users can also be made to choose individually.
By specifying it as File-system, tens of MB or more of large files can also be uploaded.
By Workflows and Templates of Items, it corrected so that images and attachment files might also be reflected in the created items.
When displaying Schedules by Group or by Team, Schedule of each member can now be shown in calendar form in a popup-window.
Popup-Calendar button has been added on Desktop.
Although a private schedule was displayed as fur as its title and time zone on the screen by group etc., it changed so that it might not be displayed at all from those other than its members.
Access to the database has been optimized and access frequency reduced.
When the number of Users is hundreds or more, there was a case where time took 10 seconds or more for an administrator opening "Folder Tree", but speed has been improved sharply.
"∧" button has been added on the Header-menu part, so that users can hide the upper part of the screen and expand the main screen.
Designs, such as by Comments to Items and Workflows, have been improved.
In addition, some bug-fixes.

» About Thetis

Sysphonic Thetis is the global standard Groupware (CMS / knowledge management system) of the next generation which supplies the newest technology about Web and Internet unstintingly, so that realizes innovative operativity and functionality. The high technique located at the peak even in the global point of view is not self-satisfaction of the development side, but utilized in the consideration completely turned to the users from the beginning. That is the reason to which Thetis is called "the world strongest". Getting bored and being insufficient for the "next-generation groupwares" with which the world is flooded, it places the pivoting foot on the "more active dispatch and sharing of the informations from each member". And it is backed by long experience which is consistent and has pursued the information platform indispensable to the communication in the organization, incorporating an original idea in plenty.
♦ ♦ By all means, please look over this manual and compare with the Groupware which you are using now. Then, it is quite obvious which is a more useful tool, and it should be known. It is just the proof whose Thetis is the "world strongest."
Thetis supports Japanese, English and German by the default.

◎ Cautions
Operation broader than a general user is possible for the user with administrator authority. Therefore, cautions need to make it not delete required data etc. enough.
An administrator also creates the account as a general user independently, and recommends you to usually login with it.

"Item" - the information unit of Thetis

【Tips】

» In Thetis, the "Item" which a user can register freely becomes an information unit, i.e., one core of each function. The data with a form copied from Word or a browser is not only stuck on an Item as it is, but it can attach as he also likes Images and Files. This "Item" plays the role of the "file" in PC.

In general groupware, places divided functionally, such as a "bulletin board" and "file management", in Thetis an "Item" equipped with information nature high in itself responds to a menu -- the message of a bulletin board, a project definition document, a workflow, each user's profile sheet, etc. are utilized and referred to variously.

Item = HTML document + Images + Attached files
Other users who read the Item can register a comment.
An administrator can register a template as he is required, and the user can choose from there at the time of creation of an Item.
An Item is managed by a "folder" with a layered structure, and reading by the user / group / team and the authority to write can be individually set to a folder.
The new-arrival Item and the addition of the comment by other users etc. can be known at any time by the updating notice on a RSS-Aggrigator.

"Group" and "Team"

[Tips]

» At Thetis, Users' organization composition can be summarized and managed in the unit of a "Group." Groups make a layered structure and, thereby, is also in the organization of a 1,000-person scale, the operativity of Thetis is not spoiled.
Only always it In Thetis, the unit of the "team" which crosses an organization can also be created. A leader registers an Item as a "project definition document", a user subscribes to it, and a leader takes the form where a member is selected from applicants. This is the flow which meant promoting "independent activity" in an organization.
As for a "team", it is of course that a project due to occupational cases is registered and promotion of information sharing can be aimed at, It is utilizable also for starting of a "circle" and a "study meeting" and also member collection of a "drinking session."

An administrator creates a "group" and it classifies a user. (Affiliation in the group of each user plurality is possible)
A user registers the outline of a project as an Item, and a "team" looks for and composes a member. (Affiliation on the team of each user plurality is possible)
When a "Group" or a "team" is created, "group folder" or "team folder" is created automatically, which only its member can access, respectively.

An administrator sets up a "group" and general users can compose a "team" dynamically.

■ Setup

1. Environment

Thetis is . Simple substance Ruby on Rails (RonR) It consists of a project and connects with a MySQL database. that -- as environment -- at least -- Ruby and Rails -- and -- MySQL must be installed. (Linux is recommended although Linux or Windows is also available for a server) And of course and Apache The Web server of Lighttpd etc. set up appropriately is required. It is if it is Linux. It is if it is FastCGI and Windows. He recommends to apply SCGI to a Web server. Please refer to the following link for each installation.


Ruby ( ver.1.8.6 / 1.8.7 )	http://www.ruby-lang.org/
Rails ( ver.2.1.2 )	http://www.rubyonrails.org/
MySQL	http://www.mysql.com/

Apache	http://httpd.apache.org/
or
Lighttpd	http://lighttpd.net/

FastCGI	http://www.fastcgi.com/
or
Ruby On Rails Using SCGI	http://www.zedshaw.com/projects/scgi_rails/

・

Installation procedure <Example> (Opens in the new window) Since all the procedures of the environmental construction for every OS appear also in it, please make it reference.（Windows Vista/XP へのセットアップ手順を追加しました。2007-12-14）
・Moreover, since we will also perform introductory support only at no charge or a cost price fundamentally if it is difficult, please do not hesitate to ask.

About Support (Opens in the new window)

To move by Rails of a version difference, it is necessary to change the next line of thetis/config/environment.rb.

RAILS_GEM_VERSION = '2.1.2'

Character encoding of MySQL should specify "UTF-8." inside of the installation folder of MySQL my.cnf -- or -- The following line is checked by my.ini.

[mysql]
default-character-set = utf8
[mysqld]
default-character-set = utf8

Next, at a command line, it is a corresponding to many languages. In order to treat Ruby-GetText and CSV data FasterCSV is installed.

# gem  install  gettext  -v  1.93.0
# gem  install  fastercsv  -v  1.2.3
# gem  install  will_paginat  -v  2.2.2

* Ruby-GetText probably requires other dependencies. For more details, please refer to "Installation procedure <Example>" mentioned above.

and MySQL top the database named "thetis_production" is created -- the following command is executed at a command line (a table is created in DB).

> cd <Path of your own environment>/thetis
> rake db:migrate RAILS_ENV=production

Access to Thetis by the following URL.

http://..../thetis/

Please specify /thetis/public folder by the configuration file of a Web server as a document root which stores static contents.

Example of Lighttpd （ lighttpd.conf ）:
In the case of FastCGI

server.modules = (
     .....
     "mod_fastcgi",
     "mod_alias",
     .....
   )
   .....
#>> Thetis comment-out 
  Comment out this line
# dir-listing.activate        = "enable"
#<< Thetis comment-out 
   .....
$HTTP["url"] =~ "^/thetis($|[/])" {
  server.document-root = "<Path of your own environment>/thetis/public"
  alias.url = ( "/thetis/" => "<Path of your own environment>/thetis/public/" )
  server.indexfiles = ( "dispatch.fcgi" )
  server.error-handler-404 = "/thetis/dispatch.fcgi"
  fastcgi.server = ( ".fcgi" =>
  ( "app-1" => ( "host" => "127.0.0.1", "port" => 7000 ),
    "app-2" => ( "host" => "127.0.0.1", "port" => 7001 ),
    "app-3" => ( "host" => "127.0.0.1", "port" => 7002 ) )
  )
}
   .....

To setup Rails Application on FastCGI

[Tips]

thetis/public/dispatch.fcgi
thetis/script/process/*

After setting execution authority as three files as follows,

# cd  <Path of your own environment>/thetis
# chmod  755  ./public/dispatch.fcgi
# chmod  755  ./script/process/*

At the time of starting (reboot) of Lighttpd

[Start]

# ruby ./script/process/spawner -p 7000

[Stop]

# ruby ./script/process/reaper -a kill

.. is required.
(Lighttpd <=> FCGI+Rails is connected in the port of 7000 as it is also in a setup of upper lighttpd.conf now)
Of course, it is Lighttpd to the configuration file at the time of a system startup about this. It is convenient if you write with a starting command.

In the case of SCGI

server.modules = ( 
   ...
#>> Thetis add 
            "mod_rewrite",
            "mod_redirect",
            "mod_scgi",
#<< Thetis add 
   ...
 )
   ...
#>> Thetis comment out 
  Comment out this line
# dir-listing.activate        = "enable"
#<< Thetis comment out 
   ...
#>> Thetis add 
$HTTP["url"] =~ "^/thetis($|[/])" {
  server.document-root = "<Path of your own environment>/thetis/public" 
  server.indexfiles = ("frames/index")
  alias.url = ("/thetis" => "<Path of your own environment>/thetis/public")
  server.error-handler-404   = "/thetis/dispatch.scgi" 
  scgi.server = ( "dispatch.scgi" => (( 
    "host" => "127.0.0.1",
    "port" => 9999,
    "check-local" => "disable" 
   )) )
  scgi.debug=3
}
#<< Thetis add 
     .....

To setup Rails Application on SCGI

[Tips]

After installing SCGI, execute the following command on Command Line, and "thetis/config/scgi.yaml" will be created.
(Password will be required, but specify arbitrarily.)
The port number linked to a Web server etc. is written on this file, and it will be referred to at the time of starting of SCGI.

> cd <Path of your own environment>\thetis
> scgi_ctrl config -S

It is convenient if you make a batch file as follows to start (restart) SCGI.
(Please ignore a message "Error: Process "ruby.exe" is not found.")

@echo off
echo Stopping SCGI Service...
taskkill /F /IM ruby.exe > nul
cd <Path of your own environment>\thetis
echo Starting SCGI Service...
scgi_service
exit

If you use SCGI (scgi_rails-0.4.3), an error occurs when booting SCGI on Rails2.0.x or above.
To correct it, please edit with your text-editor line:36 in the file "scgi_service" in your installation directory of ruby, for example,
C:\ruby\lib\ruby\gems\1.8\gems\scgi_rails-0.4.3\bin
like below:

ActiveRecord::Base.threaded_connections = false

∨

ActiveRecord::Base.allow_concurrency = false

2. Configuration

Those who are upgraded from ver.0.9.4_6 need to read 3. upgrade from ver.0.9.4_6" first.

General Configuration screen was made and editing a configuration file directly stopped almost needing from ver.0.9.3. The main items to be edited are as the following table.
(If you edit the configuration files, restarting the server is necessary.)

File	Description
thetis/config/ environment.rb	* Please refer to Strage location for Attachments » Important « below.
thetis/config/ database.yml	It is necessary to specify suitable username and password for each of three modes (development /test/production) to MySQL database in this file.

Strage location for Attachments

[Tips]

The following line was added by ver.0.9.5 at the configuration file.

∨ thetis/config/ environment.rb

THETIS_ATTACHMENT_LOCATION_DEFAULT = 'DIR'
THETIS_ATTACHMENT_LOCATION_SELECTABLE = false
THETIS_ATTACHMENT_LOCATION_DIR = File.join(File.dirname(__FILE__), '../files')

THETIS_ATTACHMENT_LOCATION_DEFAULT

If you would like to save "Attachment files" of Items in file-system of the server, please specify 'DIR'. If you prefer Database as old versions, specify 'DB'. (The default value is 'DIR')
* When selected 'DB', you cannot upload large files like number of MB or over.
(Please refer to » Important « below)

THETIS_ATTACHMENT_LOCATION_SELECTABLE

If you would like to let Users select the strage location of attachment files by showing the following column when registering them, please specify "true" (its default location is specified by the previous item). If you prefer using the previous selection without confirmation, specify "false". ("false" is the defalut)

THETIS_ATTACHMENT_LOCATION_DIR

Specify the preservation path at the time of specifying 'DIR' by the previous item. ("thetis/files" as default)
* Confirm if Web server has authority to write in the path. Without authority upload will fail.

Large files can be uploaded when the file system ('DIR') is specified as the strage location. However, keep in mind that there is a possibility that the reference by other than administrators may be attained depending on the authority (on OS) of the path.

When 'DIR' selected, attachment files will be preserved in the following structure in the specified path.

/ (The value omitted ten's place and less of User-ID)

/ (User-ID)

/ (Item-ID)

/ (Attachment-ID).(extension)

» Important «

thetis/config/environment.rb The maximum size of each attachment files and images uploaded by setup of inside and the next is specified.
THETIS_ATTACHMENT_DB_MAX_KB = 5*1024# Maximum 5MB, respectively
THETIS_IMAGE_MAX_KB = 5*1024# Maximum 5MB, respectively.
It is necessary to also set up the limit value of a database appropriately according to the value specified by these two items. For example In MySQL, it is a "max_allowed_packet" parameter About 5MB* (4/3) Please specify it as the above value (for example, 16MB). (Probably default restriction of MySQL is 1MB)
∨ my.cnf or my.ini in install folder of MySQL

[mysqld]
max_allowed_packet=16M<- This line is added, or it edits and carries out like this.

If it is disagreeable to change a setup of MySQL, it is necessary to change these items of Thetis as follows.
THETIS_ATTACHMENT_DB_MAX_KB = 500# Maximum 500KB, respectively
THETIS_IMAGE_MAX_KB = 500# Maximum 500KB, respectively

For expressing a user name as full name	[Tips]
It is possible to specify it on User Management Settings screen.

Customize of wording and images

[Tips]

It is possible to customize each part of the following elements on General Configuration screen.

Display / Non-displaying setup of Menus	[Tips]
Each menu of Equipment, Workflow, Research, User List, PaintMail can not be displayed. From It is possible to specify it on General Configuration screen. The direction of many and unspecified persons registers. In the demonstration server of Thetis with "Open User Registration Mode" the "User List" is carried out to un-displaying. Moreover, Desktop, Items/Folders, Schedules、Equipment can also be specified not to display to users without LOGIN on General Configuration screen.

Open User Registration Mode

[Tips]

User's registration can be exhibited like the demonstration server of Thetis.
It is possible to specify it on General Configuration screen.

In the Open User Registration Mode, The link to User's registration is displayed as follows, and even if not logged in, it can register as a user (a new user is informed of account information by e-mail).

<Login>

3. Upgrade from ver.0.9.4_6

Please perform upgrade from ver.0.9.4_6 in the following procedure.

(Having written on this chapter is unnecessary in the direction set up newly)

1. Version up of Rails

Update Rails. Execute following lines on the command line.

# gem install rails -v 2.1.2
# gem install gettext -v 1.93.0
# gem update --system

2. Replacement of the folder

Rename the thetis folder of previous version. (for example, thetis_bak) Then copy the thetis of ver.0.9.5 to the same directory.

In the case of Linux, please perform execution delegation to three lower scripts.

thetis/script/process/*
thetis/public/dispatch.fcgi

3. Update of Thetis Configuration

Overwrite _config.yml, _research.yml, database.yml and _secret.conf in thetis/config folder with those in thetis_bak/config folder.

When using SCGI, "config/scgi.yaml" is also to be copied into the same folder.

4. Backup of the database

A database is backed up. Please execute the following commands at a command line.

# mysqldump thetis_production -u root -p > (Arbitrary path)/thetis_ver094_6.dmp

5. Update of the database

To update the composition of the database, after moving to the thetis folder on command line, please execute the following command.

# rake db:migrate RAILS_ENV=production

6. Execute distribution of copies of decided Workflows

From ver.0.9.5, copies are automatically distributed to all related Users when Workflows get finally decided so that deletion and movement of the Items come to be done each separately. To process the decided workflows on the old versions in the same way, move to thetis folder in command-line and execute the following command.

# rake thetis:distribute_workflows RAILS_ENV=production

It may take time for a while. Please wait until processing is completed.

7. Strage location setting of Attachment files

Please specify strage location for attachment files refering to Tips - Strage location for Attachments in this manual.

The default setting points to thetis/files. If you prefer Database as old versions under the security reason or so, please modify it.

4. Setup of RSS-Aggrigator

Mozilla Thunderbird is explained here to an example for a setup of the RSS aggrigator for receiving updating information from Thetis.

1) Click "Tool" - "Account setting" to open Account setting window.

2) Click "Add accound" button.

3) Specify as follows on Account wizard and click "Complete".

Kind of account: RSS news and blogs

Account name: Specify an intelligible name suitably.

4) Returning to Account setting screen, select the account created now and click "Manage RSS subscription" button.

5) Click "Add" on "Subscription of RSS feed" screen.

6) Input URL as follows on "Property of RSS feed" screen.

http://(Address of your server)/thetis/rss/rss

7) Please set up the check interval of new-arrival notification if needed.

In order to use notification of schedules for which beginning time draws near, the periodical check of the RSS feed needs to be set up.
(When inquiry is done between 30 minutes before beginning and 10 minutes after it, Thetis notifies it with "[*Alarm*]" added before its title)

ThetisCore, the RSS Aggrigator especially for Thetis

[Tips]

ThetisCore (Opens in a new window) is recommended as RSS Aggrigator for Thetis.

Booting from the shoutcut on Desktop after installation of ThetisCore, the following icon appears in the tasktray. Click it and follow "RSS configuration" - "RSS" tab - "Add" button. Then specify like below.

» Screen composition

(1) : Emblem column
When clicking it The version information window of Thetis is displayed.

The change method of an emblem or wording of "Replace Me" and "Change this Text", "Customize of wording and images"
Please refer to it.

(2) : Login-User column
  The user name under login is displayed. It is not displayed when not logged in.
  When clicking it User information edit display It is displayed and its user information can be edited.

(3) : RSS Feed Icon
  It is displayed when RSS is validated by setup.
  Since the following attestation screens will be displayed When clicking it here, please enter the user name and password at the time of login of Thetis. The contents of RSS feeding can be checked by a browser.

The setting method of a RSS reader, "Setup of a RSS reader" Please refer to it.

(4) : Header menus
The menu of this portion is freely customizable. "Customize of wording and an image" Please refer to it.

By clicking "∧" button on the Header-menu, the upper part of the screen can be hidden so that the main screen will be expanded.

(5) : Common menus
It is a menu displayed on all the users.

Method prevent from displaying without the method of making a specific menu un-displaying, and login, "A display / non-displaying setup" of a menu Please refer to it.

(6) : Menus for administrators
  It is displayed only when logged in by a user with administrator authority.

(7) : A date and the clock column
  The present date and time are expressed as real time.
  It is a when it clicks here calendar screen (schedule: month unit) It is displayed.

>> License

New BSD License

Note : Although there is no binary for script languages such as Ruby and Javascript, in the case of redistribution please note that the provision as the "binary form" is also to be applied as the "source code".

Copyright (c) 2007-2009, MORITA Shintaro, Sysphonic. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the nächsten disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the nächsten disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Sysphonic nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

In addition to this Thetis contains the following software. Be careful also of these licenses.

FCKeditor ver.2.6.3	Copyright (C) 2003-2008 Frederico Caldeira Knabben http://www.fckeditor.net
JKL.Calendar based on ver.0.13	Copyright 2005-2006 Kawasaki Yusuke http://www.kawa.net/works/js/jkl/calender.html
Dojo ver.0.4.2(Ajax)	Copyright (c) 2005-2006, The Dojo Foundation http://dojotoolkit.org
Prototype JavaScript framework ver.1.6.0.3	(c) 2005-2008 Sam Stephenson http://prototype.conio.net/
script.aculo.us v1.8.1	Copyright (c) 2005-2007 Thomas Fuchs http://script.aculo.us

■ Common Menus

To Common Menus

■ Menus for Administrators

To Menus for Administrators