


                           CipUX-CAT-Web
                           =============

      Copyright (C) 2010 by Christian Kuelker version 0.1

                    reference to version 3.4.0.2


Installation
============

The installation instructions can be found in the README file.


Configuration
=============

The configuration take place in tree steps. Step one is to check, adopt and
eventually change the existing configuration of cipux-cat-web.ini. The default
boot strap configuration can be found under /usr/share/cipux/etc/. Have a look
at at. If the CipUX XML-RPC server and CipUX-CAT-Web is installed on the same
machine the configuration should match and there is no need to change that.
However if this is not the case or if the configuration has to be changed the
cipux-cat-web.ini file should be copied to a different location and changed
there. If the configuration at /usr/share/cipux/etc/cipux-cat-web.ini is
changed it will be overwritten by the next update.

System integrators should provide a copy of cipux-cat-web.ini at the location of
/usr/share/cipux/etc/cipux-cat-web.d/cipux-cat-web.ini.

Local system administrators can copy cipux-cat-web.ini to /etc/cipux/cipux-cat-web.ini
and change it there.

The step two gives you access to the XML-RPC server for CAT. You have to
perform this steps as root on the host of the XML-RPC server directly. This can
not be done remotely. The XML-RPC do not have to up and running.

  export TC='cipux_task_client -t'
  export CM='cipux_cat_web_module'
  $TC cipux_task_register_cat_module -o $CM
  $TC cipux_task_add_member_to_task -o cipux_task_list_cat_modules -x value=$CM
  $TC cipux_task_add_member_to_task -o cipux_task_register_cat_module -x value=$CM

The steps up till now was made on the host of the XML-RPC server. Now start or restart the
XML-RPC server to apply those changes.

Step tree: The script cipux_cat_web_module should be executed on the host where
CipUX-CAT-Web is installed. That could be but do not have to be the same host
as the XML-RPC server. It is important that the URL of the server in
cipux-cat-web.ini is valid (step 1) and that the server is up and running (step 2).[1]

  cipux_cat_web_module --list-deregistered
  cipux_cat_web_module 3.4.0.0
  CAT Login: cipadmin
  Password:
  student.cgi
  teacher_class_assignment.cgi
  class.cgi
  ... (we skip the rest)

It is possible to register only one CAT module:

  cipux_cat_web_module --register --object index.cgi --enable --verbose
  cipux_cat_web_module 3.4.0.0
  Sever [http://localhost:8001/RPC2] is reachable.
  CAT Login: cipadmin
  Password:
  Successfully added to task [cipux_task_retrieve_all_cat_module_name_shortde\
  scription_templatedir_author_version_license_isenabled_icon]
  The object [index.cgi] will be enabled
  Successfully registered [index.cgi].

To verify that:

  cipux_cat_web_module --list-registered
  cipux_cat_web_module 3.4.0.0
  CAT Login: cipadmin
  Password:
  index.cgi

In the case of installation of non recommended 3rd party CAT module, or self
written modules, it is wisely to test them at least in regards of Perl
validity.

  cipux_cat_web_list_plugin
  All available CipUX CAT Web modules:
  Found CAT module [student.cgi]
  Found CAT module [admin.cgi]
  ... (we skip the rest)

This will list all CAT module, which are installed on file system, which
could be installed by cipux_cat_web_module.

If you see an error in this list, you should uninstall such module or fix it.

It is also possible to register all modules at once:

  cipux_cat_web_module --register --all --enable --verbose                                    <22:36
  cipux_cat_web_module 3.4.0.0
  Sever [http://localhost:8001/RPC2] is reachable.
  CAT Login: cipadmin
  Password:
  Successfully added to task [cipux_task_add_member_to_class_share]
  Successfully added to task [cipux_task_remove_member_from_class_share]
  Successfully added to task [cipux_task_list_class_shares]
  Successfully added to task [cipux_task_list_members_of_class_share]
  Successfully added to task [cipux_task_list_admin_accounts]
  Object [admin_class_assignment.cgi] will be enabled
  Successfully registered [admin_class_assignment.cgi].
  ==============================================================================









---------- (footnotes)

[1]
If there is a mistake the following output can be seen:

  cipux_cat_web_module 3.4.0.0
  CAT Login: cipadmin
  Password:
  EXCEPTION: Can not get list about registered modules!
  No access for [cipadmin] to [cipux_task_list_cat_modules]





