Difference between revisions of "Frequently asked questions"

From ECHSA Congenital Database
Jump to navigationJump to search
m (What is the executable file for the DataCollectionSoftware?)
m (How to export to CSV: Question mark)
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{software-infobox}}
 +
 +
===I have entered X patients, but there are less patients in the reports. Why?===
 +
 +
There are few stages where patients can be stopped from appearing in the reports. The reasons are:
 +
 +
#Incomplete records are not shown in the reports.
 +
#The data undergoes validation. Operations that contain errors (for example surgery before birth) are stopped from appearing in the reports. To examine the validity of your data, please look at the _Validation_ tab in bottom-right section of the [[EACTS Congenital Database Software]].
 +
#Some procedures don't have [[Basic Score]] values. If a patient had only one procedure and this procedure doesn't have Basic Score value, it will not appear on the BS-related reports. The reports are:
 +
#*[[Basic Score report]]
 +
#*[[Quality of care report]]
 +
 +
===Which version of Java is needed?===
 +
 +
You need '''Java 5.0''' (also known as '''Java 1.5''') from Sun [http://www.java.com/]. If you have Java 1.4, the Software will not work!
 +
 +
If you have both versions of java installed, please check [[Starting the software from CLI|these instructions]], they'll help you find out which version is actually used.
 +
 +
===How to export to CSV?===
 +
 +
Please see [[export to CSV]].
 +
 +
===I can't start the application===
 +
 +
First, see the page [[Starting the software from CLI]]. Once you've made sure you can start the software from CLI, you can read on [[how to associate the Jar file with Java]].
 +
 
=== I can't find the download links ===
 
=== I can't find the download links ===
  
[[Include(DataCollectionSoftware/WhereToClick)]]
+
Please go to the [[download]] page.
 +
 
 +
===Another instance of Cloudscape may have already booted the database===
 +
 
 +
[[Image:software_addr.png|thumb|right|Software development team]]
 +
 
 +
This error message usually appears when trying to run two instances of the software. However, it may also occur when you have the database folder shared over the network and accessed by someone else at the same time. This solution worked with the old software, but with the new software it doesn't anymore. If you need to have more than one software instance, you need to perform a network installation.
 +
 
 +
If you are sure that the database folder is not being accessed over the network and it still complains about the "another instance", please compress the folder EactsCongenitalDatabase and send it to the [[software development team]] for diagnostics. You can compress the folder using software like WinZip or WinRar. After compression it should be of ~300kB size.
  
=== What is the executable file for the DataCollectionSoftware? ===
+
=== What is the executable file for the EACTS Database Software? ===
  
The JAR file, <pre>DataCollectionSoftware-7.x.jar</pre> is the executable file for the application. You shouldn't unpack it. It's ment to be executed directly.
+
The JAR file, <pre>Eacts-7.0.x.jar</pre> is the executable file for the application. You shouldn't unpack it. It's ment to be executed directly.
  
More technically, JAR file is not an executable (i.e. <tt>exe</tt>) file for Windows. The real executable that is run in Windows, is the "<tt>javaw.exe</tt>" file, which shoud have the parameter "<tt>-jar</tt>" and the <tt>DataCollectionSoftware-7.x.jar</tt> file. The "<tt>javaw</tt>" program starts the JavaVirtualMachine, which executes the Java binary code that is inside the JAR file. The command-line startup should look like this:
+
More technically, JAR file is not an executable (i.e. <tt>exe</tt>) file for Windows. The real executable that is run in Windows, is the "<tt>javaw.exe</tt>" file, which shoud have the parameter "<tt>-jar</tt>" and the <tt>Eacts-7.0.x.jar</tt> file. The "<tt>javaw</tt>" program starts the Java virtual machine, which executes the Java binary code that is inside the JAR file. The command-line startup should look like this:
  
 
<pre>
 
<pre>
javaw -jar DataCollectionSoftware-7.x.y.jar
+
javaw -jar Eacts-7.0.x.jar
 
</pre>
 
</pre>
  
 
When the JAR files are associated properly and you double-click it, the above command is being executed automatically (and silently - you don't see it).
 
When the JAR files are associated properly and you double-click it, the above command is being executed automatically (and silently - you don't see it).
  
=== I unzip the "DataCollectionSoftware-7.x.jar" file and there's nothing inside that I can run ===
+
=== I unzip the "Eacts-7.0.x.jar" file and there's nothing inside that I can run ===
  
You shouldn't unzip the JAR file, which is intended to be executed with Java^tm^. If JAR file has a ZIP icon, it's because your system mistakenly associated JAR file with a program like Winzip, instead of Java^tm^ JRE.
+
You shouldn't unzip the JAR file, which is intended to be executed with Java™. If JAR file has a ZIP icon, it's because your system mistakenly associated JAR file with a program like Winzip, instead of Java™ JRE.
  
 
In such case, we recommend reinstalling the JRE (Java Runtime Environment), to let it associate the JAR file type with itself. The Sun writes:
 
In such case, we recommend reinstalling the JRE (Java Runtime Environment), to let it associate the JAR file type with itself. The Sun writes:
  
''On Microsoft Windows systems, the Java 2 Runtime Environment's installation program will register a default association for Jar files so that double-clicking a Jar file on the desktop will automatically run it with '''javaw -jar'''. Dependent extensions bundled with the application will also be loaded automatically. This feature makes the end-user runtime environment easier to use on Microsoft Windows systems.'' (from: [http://java.sun.com/j2se/1.4.2/docs/guide/jar/jarGuide.html JAR Guide])
+
''On Microsoft Windows systems, the Java 2 Runtime Environment's installation program will register a default association for Jar files so that double-clicking a Jar file on the desktop will automatically run it with '''javaw -jar'''. Dependent extensions bundled with the application will also be loaded automatically. This feature makes the end-user runtime environment easier to use on Microsoft Windows systems.'' (from: [http://java.sun.com/j2se/1.4.2/docs/guide/jar/jarGuide.html JAR Guide])
  
=== I get “Unable to launch the specified application” ===
+
=== I get “Unable to launch the specified application” error ===
  
 
“Unable to launch the specified apllication” and in the details it says:
 
“Unable to launch the specified apllication” and in the details it says:
  
<pre>
+
“An error occurred while launching/running the application.
“An error occurred while launching/running the application.
+
Category: Invalid Argument Error
Category: Invalid Argument Error
+
Could not load file/URL specified: C:\DOCUME~1\UTILIZ~2\DEFINI~1\Temp\javaws5”
Could not load file/URL specified: C:\DOCUME~1\UTILIZ~2\DEFINI~1\Temp\javaws5”
 
</pre>
 
  
You need to associate the JAR files differently. JAR files should be associated with
+
You need to associate the JAR files with
  
<pre>
+
javaw -jar
javaw -jar
 
</pre>
 
  
 
=== Why is in the diagnosis/procedures list the possibility X not available any more? ===
 
=== Why is in the diagnosis/procedures list the possibility X not available any more? ===
  
The new software contains updated short-list. The procedure/diagnosis
+
The new software contains updated short-list. The procedure/diagnosis was probably excluded from short-list. Current
was probably excluded from short-list. Current
 
 
procedures and diagnoses short-list follows the document:
 
procedures and diagnoses short-list follows the document:
  
<pre>EACTS-STS Diagnosis and Procedure Short Lists 2004-10-24.xls</pre>
+
EACTS-STS Diagnosis and Procedure Short Lists 2004-10-24.xls
 +
 
 +
The document was originally in XLS format. You can download the PDF version of this file: [[Media:EACTS-STS Diagnosis and Procedure Short Lists 2004-10-24.pdf|EACTS-STS Diagnosis and Procedure Short Lists 2004-10-24.pdf]]
  
=== When and how can the completed files be sent to the CentralDatabase? ===
 
  
The next release of software will contain the data export function. When it's implemented, you will be able to export the data on demand. See also DataCollectionSoftware/DataExport.
 
  
 
=== What is the primary key for the Patient table? ===
 
=== What is the primary key for the Patient table? ===
Line 55: Line 84:
 
The primary key consists of '''two''' fields: the hospital code and automatically generated integer number.  
 
The primary key consists of '''two''' fields: the hospital code and automatically generated integer number.  
  
The graphical user interface of the Data Collection Software does not show the primary key anywhere. If you want to export the data from the Data Collection Software to other relational database, the primary key will get exported as well. The patient table looks like this:
+
The graphical user interface of the [[EACTS Database Software]] does not show the primary key anywhere. If you want to export the data from the [[EACTS Database Software]] to other relational database, the primary key will get exported as well. The patient table looks like this:
  
||'''Hospital Code'''||'''Number'''||'''First Name'''||'''Last Name'''||'''Other fields...'''||
+
{|border="1" cellpadding="2"
||ABC||1||John||Doe||...||
+
!Hospital Code
||ABC||2||Ann Mary||Smith||...||
+
!Number
 +
!First Name
 +
!Last Name
 +
!Other fields...
 +
|-
 +
|ABC
 +
|1
 +
|John
 +
|Doe
 +
|...
 +
|-
 +
|ABC
 +
|2
 +
|Ann Mary
 +
|Smith
 +
|...
 +
|}
  
For information about the primary key in CSV export files, please read ../ExportToCsv
+
For information about the primary key in CSV export files, please read about the [[data export]].
  
Please note that the primary key is something different from the local ID.  
+
Please note that the primary key is something different from the local ID.
  
 
=== What is the Patient's Local ID? ===
 
=== What is the Patient's Local ID? ===
Line 69: Line 114:
 
'''Patient local ID''' technically is a plain text field. It can be used by the hospital according to the center's needs. This field is exported to the central database and can be used to track exported patients.
 
'''Patient local ID''' technically is a plain text field. It can be used by the hospital according to the center's needs. This field is exported to the central database and can be used to track exported patients.
  
=== How to configure the user and password for the database in the NetworkInstallation? ===
+
=== How to configure the user and password for the database in the [[Network installation]]? ===
  
The user name and password are defined in the <pre>dburl</pre> variable in the <pre>ecdbc.properties</pre> file. Please consult the [[network installation]] for details.
+
The user name and password are defined in the <tt>dburl</tt> variable in the <tt>ecdbc.properties</tt> file. Please consult the [[network installation]] for details.
  
 
=== Why the network version of software works slow? ===
 
=== Why the network version of software works slow? ===
Line 80: Line 125:
  
 
For information about the primary key in CSV export files, please read about the [[data export]].
 
For information about the primary key in CSV export files, please read about the [[data export]].
 +
 +
===How to join tables===
 +
 +
Please see [[export to CSV]].
  
 
=== Any other questions not answered here ===
 
=== Any other questions not answered here ===
  
Please write [mailto:software@magnum2.pl].
+
Please write the [[software development team]].
 +
 
 +
[[category:technical support]]

Latest revision as of 18:57, 25 July 2006

ECHSA Database Software

Download
Change log
User's manual
FAQ

Software information

Technical support
Recommended hardware
Requirements
Licensing
Versions
Platforms
What's new

Get involved

Development version
How to report bugs
Source code
Internationalization
How to translate
Technical documentation

I have entered X patients, but there are less patients in the reports. Why?

There are few stages where patients can be stopped from appearing in the reports. The reasons are:

  1. Incomplete records are not shown in the reports.
  2. The data undergoes validation. Operations that contain errors (for example surgery before birth) are stopped from appearing in the reports. To examine the validity of your data, please look at the _Validation_ tab in bottom-right section of the EACTS Congenital Database Software.
  3. Some procedures don't have Basic Score values. If a patient had only one procedure and this procedure doesn't have Basic Score value, it will not appear on the BS-related reports. The reports are:

Which version of Java is needed?

You need Java 5.0 (also known as Java 1.5) from Sun [1]. If you have Java 1.4, the Software will not work!

If you have both versions of java installed, please check these instructions, they'll help you find out which version is actually used.

How to export to CSV?

Please see export to CSV.

I can't start the application

First, see the page Starting the software from CLI. Once you've made sure you can start the software from CLI, you can read on how to associate the Jar file with Java.

I can't find the download links

Please go to the download page.

Another instance of Cloudscape may have already booted the database

Software development team

This error message usually appears when trying to run two instances of the software. However, it may also occur when you have the database folder shared over the network and accessed by someone else at the same time. This solution worked with the old software, but with the new software it doesn't anymore. If you need to have more than one software instance, you need to perform a network installation.

If you are sure that the database folder is not being accessed over the network and it still complains about the "another instance", please compress the folder EactsCongenitalDatabase and send it to the software development team for diagnostics. You can compress the folder using software like WinZip or WinRar. After compression it should be of ~300kB size.

What is the executable file for the EACTS Database Software?

The JAR file,

Eacts-7.0.x.jar

is the executable file for the application. You shouldn't unpack it. It's ment to be executed directly.

More technically, JAR file is not an executable (i.e. exe) file for Windows. The real executable that is run in Windows, is the "javaw.exe" file, which shoud have the parameter "-jar" and the Eacts-7.0.x.jar file. The "javaw" program starts the Java virtual machine, which executes the Java binary code that is inside the JAR file. The command-line startup should look like this:

javaw -jar Eacts-7.0.x.jar

When the JAR files are associated properly and you double-click it, the above command is being executed automatically (and silently - you don't see it).

I unzip the "Eacts-7.0.x.jar" file and there's nothing inside that I can run

You shouldn't unzip the JAR file, which is intended to be executed with Java™. If JAR file has a ZIP icon, it's because your system mistakenly associated JAR file with a program like Winzip, instead of Java™ JRE.

In such case, we recommend reinstalling the JRE (Java Runtime Environment), to let it associate the JAR file type with itself. The Sun writes:

On Microsoft Windows systems, the Java 2 Runtime Environment's installation program will register a default association for Jar files so that double-clicking a Jar file on the desktop will automatically run it with javaw -jar. Dependent extensions bundled with the application will also be loaded automatically. This feature makes the end-user runtime environment easier to use on Microsoft Windows systems. (from: JAR Guide)

I get “Unable to launch the specified application” error

“Unable to launch the specified apllication” and in the details it says:

“An error occurred while launching/running the application.
Category: Invalid Argument Error
Could not load file/URL specified: C:\DOCUME~1\UTILIZ~2\DEFINI~1\Temp\javaws5”

You need to associate the JAR files with

javaw -jar

Why is in the diagnosis/procedures list the possibility X not available any more?

The new software contains updated short-list. The procedure/diagnosis was probably excluded from short-list. Current procedures and diagnoses short-list follows the document:

EACTS-STS Diagnosis and Procedure Short Lists 2004-10-24.xls

The document was originally in XLS format. You can download the PDF version of this file: EACTS-STS Diagnosis and Procedure Short Lists 2004-10-24.pdf


What is the primary key for the Patient table?

The primary key consists of two fields: the hospital code and automatically generated integer number.

The graphical user interface of the EACTS Database Software does not show the primary key anywhere. If you want to export the data from the EACTS Database Software to other relational database, the primary key will get exported as well. The patient table looks like this:

Hospital Code Number First Name Last Name Other fields...
ABC 1 John Doe ...
ABC 2 Ann Mary Smith ...

For information about the primary key in CSV export files, please read about the data export.

Please note that the primary key is something different from the local ID.

What is the Patient's Local ID?

Patient local ID technically is a plain text field. It can be used by the hospital according to the center's needs. This field is exported to the central database and can be used to track exported patients.

How to configure the user and password for the database in the Network installation?

The user name and password are defined in the dburl variable in the ecdbc.properties file. Please consult the network installation for details.

Why the network version of software works slow?

There can be many reasons for it. One of them is the lack of configuration of the revDNS. While operating in the local networks, computers try to resolve IP numbers, e.g. 192.168.0.4 to a DNS canonical name (like somehost.localnet). When the revDNS is not configured to resolve IP numbers to canonical names, the computer waits about 30 seconds for the IP number to be resolved, and this is perceived as application slowness.

There is no unique identifier in each CSV/Excel file, i.e. "Primary Key"

For information about the primary key in CSV export files, please read about the data export.

How to join tables

Please see export to CSV.

Any other questions not answered here

Please write the software development team.