From cf092246ceb2e5150873071fb0d658e1b2cb790b Mon Sep 17 00:00:00 2001 From: Jan Blom Date: Wed, 10 May 2023 14:18:47 +0200 Subject: [PATCH] Review documentation --- docs/WhiteRabbit.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/WhiteRabbit.md b/docs/WhiteRabbit.md index db877d20..8790f4f0 100644 --- a/docs/WhiteRabbit.md +++ b/docs/WhiteRabbit.md @@ -48,17 +48,19 @@ If you have a 32-bit Java VM installed and problems persist, consider installing ### Temporary Directory for Apache POI (This addresses [issue 293](https://github.com/OHDSI/WhiteRabbit/issues/293)) -The Apache POI library is used for generated the report in Excel format. This library creates its own directory for -temporary files in the system temporary directory. It has been reported that this can cause problems in a multi-user -environment, when each user attempts to create this directory with too restrictive permissions (read-only for other -users). WhiteRabbit from version 0.10.9 tries to circumvent this automatically, but this workaround can fail due -to concurrency problems. If you want to prevent this from happening, you can set either the environment variable -```ORG_OHDSI_WHITERABBIT_POI_TMPDIR``` or the Java system property ```org.ohdsi.whiterabbit.poi.tmpdir``` when starting -WhiteRabbit (best would be to add this to the ```whiteRabbit``` or ```whiteRabbit.bat``` script). Please note that -this directory should exist before your start WhiteRabbit, and is writable by any user that may want to run -WhiteRabbit. Each user will then have a separate subdirectory, so that further conflicts should be avoided. -Also, WhiteRabbit now attempts to detect this situation before the scan starts, so that the scan is not started, and -the problem identified sooner. +The Apache POI library is used for generating the scan report in Excel format. This library creates its own directory for +temporary files in the system temporary directory. In [issue 293](https://github.com/OHDSI/WhiteRabbit/issues/293) it has +been reported that this can cause problems in a multi-user environment, when multiple user attempt to create this directory +with too restrictive permissions (read-only for other users). +WhiteRabbit from version 0.10.9 attempts to circumvent this automatically, but this workaround can fail due +to concurrency problems. If you want to prevent this from happening entirely , you can set either the environment variable +```ORG_OHDSI_WHITERABBIT_POI_TMPDIR``` or the Java system property ```org.ohdsi.whiterabbit.poi.tmpdir``` to a +temporary directory of your choice when starting WhiteRabbit (best would be to add this to the ```whiteRabbit``` or +```whiteRabbit.bat``` script). Please note that this directory should exist before your start WhiteRabbit, +and that it should be writable by any user that may want to run WhiteRabbit. +For each user a separate subdirectory will be created, so that permission related conflicts should be avoided. +Also, WhiteRabbit now attempts to detect this situation before the scan starts. If this is detected, +the scan is not started, and the problem identified before the scan, instead of afterwards. ## Support All source code, descriptions and input/output examples are available on GitHub: