rtcDoku

Installation Instructions

rtcDokuJob is a script written in TCL, intended to be implemented in Infopark's CMS Fiona. rtcDokuJob generates an overview of the defined file formats, their fields and the jobs in the system. This document explains how the script is integrated into an instance of the CMS.

Licence

rtcDokuJob has been developed by Jetaido GmbH and is released as free software, licenced via the GPL. You have the right to freely install and distribute it. We distribute rtcDokuJob without any warranty or responsibility for any damages that might occur to your system.

Requirements

You need

Implementation

Step 1: Copy the script

Copy the file rtcDokuJob.tcl into your instance/default/scripts/cm/serverCmds folder. Make sure it is accessible for your 'nps' user. Restart the CM process so that the tcl file is sourced.

Step 2: Create a file for the job's output

Create the file in which you want to save the output of the job. In this example, we create a file "rtcDoku" in the folder /misc/docu of our CMS. Make sure, that the file is of an appropriate type (folder or document file).

(You can click on any of the images to enlarge them.)

Step 3: Find out the file's object id

Find out the object id of the file you just created. You have to click on that file, select "Details" from the "View" menu and click on the tab "Administration" on the right. After that, the id is shown. In this example, the id is 8499868.

Step 4: Create a new Job

Create a new job by clicking on "Extras", "System Configuration", "Jobs" and "New".

You can enter the following information:
Name: "rtcDokuJob"
Title: "Documentation Job for Systems Configuration"
Comment: "Creates a documentation of the available file formats, their attributes and the jobs"
Schedule: Select "Create Schedule", "Minute 1", "Hour 1", "Monday", "Ok" for the job to be executed on each monday at 01:01 o'clock.
Script: Copy the following code into the script field:

# id of the file that should contain the rtcDoku
set fileId 8499868
# language, in which to generate the rtcDoku
# possible values: en (english), de (german)
set lang en
# do you want the publish the rtcDoku file
set releaseFile no
# no configuration below this line needed!
catch {obj withId $fileId edit}
catch {obj withId $fileId take}
catch {obj withId $fileId editedContent set blob [rtcDokuJob $lang]} err1
if {$releaseFile == "yes"} {
   catch {obj withId $fileId release} err2
} else {
   set err2 ""
}
if {[string length $err1$err2] == 0} {
   set result {job terminated successfully.}
} else {
   set result [list job terminated with errors: $err1 $err2]
}

Make sure you replace the id in this example with the id from Step 3.

You can configure the output of the Job by changing the value of the variable 'lang'. If you replace "set lang en" with "set lang de", all output will be in German. So far, only German and English are available. Please check that you have titles and descriptions for your system configuration values (such as fields, for instance) in the appropriate languages.

If you want to release the file, that contains the rtcDoku, simply change the value of the variable releaseFile from no to yes. The rtcDoku will then be regularly published.

Step 5: Run the Job

Save the new job and run it. After some seconds, you can view the file, that you created in Step 2 using the internal preview of the Infopark CMS Fiona. You should see a list of all file formats, their fields and the jobs.

Please note:
If you want to have maximum benefit of this job, make sure you fill in sensible values into the fields "title" and "description" of your system settings. So, upon creating/editing a file format, for instance, insert a title and a description for this file format in the system configuration.