From 9c31207fdc05449c0407a0eeead0e1d3283ab2cd Mon Sep 17 00:00:00 2001 From: Robert Treacy Date: Tue, 11 Aug 2020 12:35:28 -0400 Subject: [PATCH 1/4] The sample ejb-jar.xml file had a bad version number that would prevent deployment of the application if the ejb-jar file was used to modify the saved searchers timer schedule. I updated the timer.rst file to document a procedure for inserting an edited ejb-jar.xml file into a war, rather than doing a full build of the application --- .../source/_static/admin/ejb-jar.xml | 2 +- doc/sphinx-guides/source/admin/timers.rst | 25 ++++++++++++++++++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/doc/sphinx-guides/source/_static/admin/ejb-jar.xml b/doc/sphinx-guides/source/_static/admin/ejb-jar.xml index 5ea6330753a..b25cefb6340 100644 --- a/doc/sphinx-guides/source/_static/admin/ejb-jar.xml +++ b/doc/sphinx-guides/source/_static/admin/ejb-jar.xml @@ -1,6 +1,6 @@ diff --git a/doc/sphinx-guides/source/admin/timers.rst b/doc/sphinx-guides/source/admin/timers.rst index 3495c49c98e..51a03eba4b2 100644 --- a/doc/sphinx-guides/source/admin/timers.rst +++ b/doc/sphinx-guides/source/admin/timers.rst @@ -59,7 +59,7 @@ This job is automatically scheduled to run once a week at 12:30AM local time on * Create or edit dataverse/src/main/webapp/WEB-INF/ejb-jar.xml, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. -* Edit the parameters in the section ejb-jar file in the WEB-INF directory to suit your preferred schedule +* Edit the parameters in the section of the ejb-jar file in the WEB-INF directory to suit your preferred schedule * The provided parameters in the sample file are , , and ; additional parameters are available @@ -67,6 +67,29 @@ This job is automatically scheduled to run once a week at 12:30AM local time on * Build and deploy the application +* Alternatively, you can insert an ejb-jar.xml file into a provided dataverse war file without building the application. + + * Check if there is already an ejb-jar.xml file in the war file (as I'm writing, the dataverse war file is named dataverse-4.20.war) + + * jar tvf dataverse-4.20.war | grep ejb-jar.xml + + * if the response includes " WEB-INF/ejb-jar.xml", you will need to extract the ejb-jar.xml file for editing + + * jar xvf dataverse-4.20.war WEB-INF/ejb-jar.xml + + * edit the extracted WEB-INF/ejb-jar.xml, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. + + * if the response is empty, create a WEB-INF directory and create en ejb-jar.xml file in it, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. + + * edit the parameters in the section of the WEB-INF/ejb-jar.xml to suit your preferred schedule + + * Insert the edited WEB-INF/ejb-jar.xml into the dataverse war file + + * jar uvf dataverse-4.20.war WEB-INF/ejb-jar.xml + + * Deploy the war file + + See also :ref:`saved-search` in the API Guide. Known Issues From 03ecbe508e59b9bfba63837536528ade76930173 Mon Sep 17 00:00:00 2001 From: Robert Treacy Date: Tue, 11 Aug 2020 14:46:35 -0400 Subject: [PATCH 2/4] tweak dataverse-4.20.war to generic $DATAVERSE-WAR-FILENAME --- doc/sphinx-guides/source/admin/timers.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/sphinx-guides/source/admin/timers.rst b/doc/sphinx-guides/source/admin/timers.rst index 51a03eba4b2..b9cf112af2c 100644 --- a/doc/sphinx-guides/source/admin/timers.rst +++ b/doc/sphinx-guides/source/admin/timers.rst @@ -69,13 +69,13 @@ This job is automatically scheduled to run once a week at 12:30AM local time on * Alternatively, you can insert an ejb-jar.xml file into a provided dataverse war file without building the application. - * Check if there is already an ejb-jar.xml file in the war file (as I'm writing, the dataverse war file is named dataverse-4.20.war) + * Check if there is already an ejb-jar.xml file in the war file - * jar tvf dataverse-4.20.war | grep ejb-jar.xml + * jar tvf $DATAVERSE-WAR-FILENAME | grep ejb-jar.xml * if the response includes " WEB-INF/ejb-jar.xml", you will need to extract the ejb-jar.xml file for editing - * jar xvf dataverse-4.20.war WEB-INF/ejb-jar.xml + * jar xvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml * edit the extracted WEB-INF/ejb-jar.xml, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. @@ -85,7 +85,7 @@ This job is automatically scheduled to run once a week at 12:30AM local time on * Insert the edited WEB-INF/ejb-jar.xml into the dataverse war file - * jar uvf dataverse-4.20.war WEB-INF/ejb-jar.xml + * jar uvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml * Deploy the war file From 4e081553f81965ba30db0809908603ac3380b8e1 Mon Sep 17 00:00:00 2001 From: Michael Heppler Date: Wed, 12 Aug 2020 14:25:07 -0400 Subject: [PATCH 3/4] Fixed bulleted list formatting changing the number of spaces to indent sub-bullet points [ref #7175] --- doc/sphinx-guides/source/admin/timers.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/sphinx-guides/source/admin/timers.rst b/doc/sphinx-guides/source/admin/timers.rst index b9cf112af2c..782de98862f 100644 --- a/doc/sphinx-guides/source/admin/timers.rst +++ b/doc/sphinx-guides/source/admin/timers.rst @@ -69,25 +69,25 @@ This job is automatically scheduled to run once a week at 12:30AM local time on * Alternatively, you can insert an ejb-jar.xml file into a provided dataverse war file without building the application. - * Check if there is already an ejb-jar.xml file in the war file + * Check if there is already an ejb-jar.xml file in the war file - * jar tvf $DATAVERSE-WAR-FILENAME | grep ejb-jar.xml + * jar tvf $DATAVERSE-WAR-FILENAME | grep ejb-jar.xml - * if the response includes " WEB-INF/ejb-jar.xml", you will need to extract the ejb-jar.xml file for editing + * if the response includes " WEB-INF/ejb-jar.xml", you will need to extract the ejb-jar.xml file for editing - * jar xvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml + * jar xvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml - * edit the extracted WEB-INF/ejb-jar.xml, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. + * edit the extracted WEB-INF/ejb-jar.xml, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. - * if the response is empty, create a WEB-INF directory and create en ejb-jar.xml file in it, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. + * if the response is empty, create a WEB-INF directory and create en ejb-jar.xml file in it, following the :download:`sample file <../_static/admin/ejb-jar.xml>` provided. - * edit the parameters in the section of the WEB-INF/ejb-jar.xml to suit your preferred schedule + * edit the parameters in the section of the WEB-INF/ejb-jar.xml to suit your preferred schedule - * Insert the edited WEB-INF/ejb-jar.xml into the dataverse war file + * Insert the edited WEB-INF/ejb-jar.xml into the dataverse war file - * jar uvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml + * jar uvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml - * Deploy the war file + * Deploy the war file See also :ref:`saved-search` in the API Guide. From 6dac9ed8a0df405c56e85a4ff96fb868d0f0a8d3 Mon Sep 17 00:00:00 2001 From: Michael Heppler Date: Wed, 12 Aug 2020 14:36:17 -0400 Subject: [PATCH 4/4] Fixed bulleted list indenting redux in the Admin Guide [ref #7175] --- doc/sphinx-guides/source/admin/timers.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/sphinx-guides/source/admin/timers.rst b/doc/sphinx-guides/source/admin/timers.rst index 782de98862f..0408c74ccd0 100644 --- a/doc/sphinx-guides/source/admin/timers.rst +++ b/doc/sphinx-guides/source/admin/timers.rst @@ -83,11 +83,11 @@ This job is automatically scheduled to run once a week at 12:30AM local time on * edit the parameters in the section of the WEB-INF/ejb-jar.xml to suit your preferred schedule - * Insert the edited WEB-INF/ejb-jar.xml into the dataverse war file + * Insert the edited WEB-INF/ejb-jar.xml into the dataverse war file * jar uvf $DATAVERSE-WAR-FILENAME WEB-INF/ejb-jar.xml - * Deploy the war file + * Deploy the war file See also :ref:`saved-search` in the API Guide.