FAQ

You will find here the frequently asked questions on the mailing lists. If you think that a question could be add, don't hesitate to propose it.

Presentation

  • For all questions about Cyberdocs presentation, consult this page.

Installation

First steps...

Publishing module

Management and conversion module 

Others

Answers

On which system does Cyberdocs works?

The various modules of the platform Cyberdocs were designed to be as portable as possible. However, they use different technologies, which is some variation in the specification of systems where you can install each module. Consultat the documentation for more information.

How to recover the sources?

You can find how to download the latest sources on the downloading page. It is higly recommended to take the latest sources version in SVN.

Is it preferable to download the sources through SVN?

It is highly recommended to use the lastest version of sources through SVN, in order to benefit of the lastest corrections.

During the installation, I got the message: Error: JAVA_HOME is not defined correctly.

You have to set the environment variable JAVA_HOME, containing the JVM installation path.

For example : export JAVA_HOME=/usr/jdk1.6.0  or set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_08 

During the installation, I got error messages on inexistent files though I can see them.

Verify that there's no space or special caracter in the folder's name containing the Cyberdocs' sources.

I get a similar error to:  BUILD FAILED: file:build.xml:181: OpenOffice.org1.0.3\program\classes not found.

The specified OpenOffice folder in the pcd.properties files is wrong or the OpenOffice version is not full or compatible. Some pre-installed versions with Linux distribution do not contain all the necessary classes to Cyberdocs. Download OpenOffice from the  official website.

I get a similar error to: BUILD FAILED: file:build.xml:619: Could not create tomcat\webapps\sdx\WEB-INF\sdx\applications\theses.

or

After launching installation-web.sh, script the application is still not visible in SDX.

The access path to SDX specified in the pcd.properties (dossier.installation.consultation) is corrupted. Correct it and verify that the files have not been copied in the wrong folder.

After lauching installation-web.sh, script the application is visible in SDX but it is not deploy.

Check the name of the application in pcd.properties and configuration for access to databases in your application.xconf file (especially if you have changed the default content). You can also see the logs in the directory tomcat/webapps/sdx/WEB-INF/logs/.

When I try to get to a diffusion application page, I got the error: java.lang.ClassNotFoundException:org.apache.cocoon.transformation.CachingCIncludeTransformer.

You forgot to give the value of cocoon.class.cinclude and cocoon.class.wildcard in the pcd.properties file, according to your SDX version (2.2 or 2.3). 

When I try to access a page of the diffusion application, I got the error: java.io.FileNotFoundException: C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps\sdx\pcd\conf\logicsheets\xsp-pcd.xsl (specified access path unfound)

You didn't correctly fill the value of sdx.logicsheet.path in the pcd.properties, according to your SDX version (2.2 ou 2.3). 

When I try to access a diffusion application page, I got the error: org.apache.avalon.framework.configuration.ConfigurationException: Element 'component-configurations' is not allowed at file:/C:/Program%20Files/Apache%20Group/Tomcat%204.1/webapps/sdx/pcd/sitemap.xmap:365:33

The src/web/sitemap.xmap file contains unique compatible elements with SDX version 2.3 (recommended version). However if you want to use the 2.2 version, comment the lies <map:component-configurations> in src\web\sitemap.xmap

Some parts or images are missing in the publishing pages site.

Did you launch the installation script copie-institution.sh/bat ?

If so, verify that all files have been copied during the installation.

Think to explicitely download all the frame in your browser: right click -> This frame -> Shift key + Actualise the frame. You can also empty the cache. 

While searching or indexing a document, SDX returns an exception java out of memory, what to do?

You can also uprise the authorise memory in the JVM. For example, you can add (or modify) at the top of the tomcat/bin/catalinat.sh file:

export JAVA_OPTS="-Xms256m -Xmx2048m" 

Restart Tomcat.  

I modify xsl or xml files in the folder webapps/sdx/monappli/xsl and modifications are not visible online.

By default, the xsl changes are taken into account only when the modification dates of xsl files of the directory sdx/myapp/habillage/xsl were changed. The dates for modification of files in the directory xsl at the basis of the application sdx are not taken into account.
To work around this problem, you can:
Restart Tomcat (or your servlet engine). To save time, it is advisable to use the Tomcat Manager or extension Tomcat with Eclipse.
Edit files from the source and revive installation-web.sh/bat dealing with change dates change. Some text editors allow you to create shortcuts to commands sh or Dos. 

I don't know how to change the admin password or create a user account fo the publishing module.

You must use the web application of SDX administration located at the following address: http://your_server [: 8080]/sdx/sdx/admin/index.xsp.
By clicking on "Manage" of the SDX server, you change the overall SDX, which allows you to manage all the applications. The default login is "admin" without a password. It is therefore strongly advised to change it.
By clicking "Administer" for a particular application, you only change the configuration of the application in question.
By default, there is a "admin" account without a password, belonging to the group admins.
 

Can we do savings of the documents base?

Yes. Here are some examples:
With the backup of the system: if you are using a database files, careful not to index a document during backup ... It is even recommend to stop your servlet engine, passing your site in maintenance for a few minutes.
By asking SDX to create a backup file (reimportation untested) via the administrative interface: button "explore" and "save". This can be very long. The backup files are automatically placed in the directory webapps/sdx/myapp/conf/backup. The files can be large, do not keep them indefinitely. 

I got a blank page when I go on the index page of the management module.

This problem may have multiple causes:
Make sure that your version of PHP is far greater or equal to 4.3 for Linux and 5.0 for Windows. In all cases, we recommend version 5 or higher. To find your version of PHP, you can type: "php –version" in a terminal.
A runtime error can be masked because of the configuration of php. In php.ini, make sure "display_errors = On" the time of installation. This should allow you to see the errors and detect problems. You can certainly find a solution to the remaining issues in this FAQ.
If there is no error, check the apache logs and access rights to the directory and php data, as indicated in the documentation.
Check apache configuration for PHP scripts. Verify that no essential function is lacking.
 

I got warning php when I go on the index page of the management module.

The current version of the management module requires to stop displaying warning. In any case, for a production server, it is preferable not to display errors. If you just want to disable the warning, modify php.ini the following way:

error_reporting  =  E_ALL & ~E_NOTICE & ~E_STRICT 

I got the error utf8_encode unknown function on the index page of the management module.

You have to install the PHP-XML module: you can install it by typing apt-get install php-xml or yum install php-xml with Fedora.

The php.net page about this module: http://fr.php.net/manual/fr/ref.xml.php 

I can't authentify myself for the first time in the management module.

By default, the login is root, without a password. The first thing you should do will be to put a password.
If despite that, you can not authenticate, verify that:
Cookies are not been blocked by your browser.
Files directories production and data are accessible in writing.
The php pages can write files sessions in the temporary directory in the system: there shall not be any restrictions, including by SELinux

I got an error can't write ...  when I try to create an institution, a user, a document space or to launch a conversion.

You have to give written rights to files of the directories data and production. 

I got a blank page or an error when I download a file in the document's space.

or

I can't send some files in the management module.

Verify in php.ini that file_uploads = On. Furthermore, depending on the maximum size of the files you want to send by the management interface, also settle the following parameters:

For example, for 500Mo file at the max, add 50Mo for post_max_size and 100Mo for memory_limit :

upload_max_filesize = 500M

post_max_size = 550M

memory_limit = 600M

After any modification of php.ini, you must restart your web server. 

I got a message "The document file should have the extension .sxw ..." when I download a document.

This message is "normal" for reasons of management process; it is preferable not to have to use OpenOffice during the conversion. The simplest way is to save your file with DOC in SXW OpenOffice on your workstation and use SXW file for conversion.
If you want to convert directly DOC files, it will be necessary to properly install OpenOffice as indicated in the documentation. Note that in this case, a single conversion is possible simultaneously, OpenOffice does not allow simultaneous recording files.

When I click on "Complete treatment" nothing happens.

Most of the time, it is an error in the binary path of php (dossier.installation.php) in pcd.properties. For its location, you can use the command "which php". If the file has a different name, create a link to it, to be called "php". 

When I click on "Complete treatment", I got a blank page after 30sec or a "waiting time exceeded".

Three configuration errors can cause this problem:

  • Your version of php is too old. The management module requires php version >= 4.3 for Linux and PHP version> = 5.0 for Windows.
  • The directory "production" is not accessible writing for php pages (on your web server).
  • PHP is installed CGI: for reasons of process management, the management module can only be used with PHP installed as a module. Refer to the documentation for PHP (www.php.net) and your web server. 

In the treatment result page, I got only the message: JAVA_HOME not defined correctly...

You have failed to add the JAVA_HOME environment variable to your system or your httpd.conf file.
For example: SetEnv JAVA_HOME /usr/jdk1.6.0 (be careful of the spaces)
Think to restart your Web server after change in the configuration.
 

In the treatment result page, I got a message "file not found" followed by a fatal error.

The name of the document file to convert contains spaces or special characters. Delete the file and rename it. Always choose simple filenames. For example: nameauthor_firstname.sxw. 

During a conversion, I got a similar error as: java.lang.InternalError: Can't connect to X11 window server using ':5' as the value of the DISPLAY variable.

Most of the time, it is simply incorrect configuration in the file pcd.properties. Verify that the dossier.installation.xvfb and CD_DISPLAY are correct.
To find the path to Xvfb, you can use the command which Xvfb. If Xvfb not installed, download the package for your distribution. A note that if there is no X server installed on your machine, you can not use Cyberdocs.
For CD_DISPLAY, it is the value for the variable DISPLAY environment: you need to use a value that is never used by another application. If you want information on the operation of an X server, check the documentation of Xorg. Most of the time, a value at 5 is not a problem. 

In the treatment result page, I got a java out of memory exception for some documents, what to do?

You can increase the memory allowed for the JVM. You can do it for your overall system (see your doc JVM) or specifically for Cyberdocs by modifying the file "ant.bat" and modifying the parameter-Xmx500m.
FOR PDF FILES:
This is an unresolved problem: for very large documents, print PDF files does not generate fully.
One solution is to create your own PDF, for example, since the HTML or XHTML. Note that you will need to create a PDF file by part of Level 1 of the document and complete a PDF file. The easiest way is to observe how are created PDF files on a document properly converted.
This problem is caused by the converter used XML to PDF (FOP).
An alternative approach is under study. 

An important problem happened while a conversion and it is still indicated as "ongoing" while it's no longer the case.

Edit the file batch.dat located in the directory php/data. Look for the identification of material and remove the line. Save the file.
ATTENTION: obey the file format and does not add "empty" line.

I lost the management module administrator password, how to reinitialize?

Edit the file config.dat located in the directory php/data. Look for the username and delete the password fingerprint (a code between two ":"). The line should look like: "cdadm: root: admin." 

I got a non listed error and no error message to guide me, what to do?

If the error concerns the publishing module, the first step is to consult the log files of SDX, which are in the webapps\sdx\WEB-INF\logs. You can also check those of your servlet engine. As a general rule, you can ask for help on the mailing lists. Take time to read the archives, your question has probably been asked before. Finally, if you have a problem that you have found a solution, do not hesitate to report it on the list, it could interest the other users and be added to this page.