Difference between revisions of "DPT manual Installation and launch"

From Archives Portal Europe Wiki
Jump to: navigation, search
m (Protected "DPT manual Installation and launch" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading])
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
The tool is distributed as a zip-file, named: '''''APE_data_preparation_tool_2.6.1.zip''''', where the number indicates the version of the tool. The most recent version of the tool (v2.6.1) is available for download over [http://dpt.archivesportaleurope.net/APE_data_preparation_tool_2.6.1.zip here].
+
The content of this page has been integrated into the [https://www.archivesportaleurope.net/tools/for-content-providers/data-preparation/data-preparation-tool-manual/ website of Archives Portal Europe] now.
 
+
The only requirement that is needed for running the tool is that you need to have Java 6 or higher installed on your computer. You can verify whether Java is installed on your computer, and which version, by launching the command prompt (Windows) or terminal (Linux) and typing: '''''java -version'''''. On a MacIntosh computer you can go to 'system preferences' and see if there is a Java icon there, if so, Java is installed and you can click on the icon to check the version. 
+
 
+
Once you have downloaded the zip-file please do the following:
+
 
+
* Uncompress the zip-file with winzip, 7-zip, unzip or a similar tool towards a location of your choice to create the executable and auxiliary files: two folders (named: '''''lib''''' and '''''xsl''''') and five files:
+
 
+
[[File:APE_DPT_manual_01.png|400px|thumb|left|APE DPT manual, figure 1]]
+
<br clear=all>
+
 
+
* To launch the tool please perform the following steps according to your operating system (OS):
+
** Using Windows: double-click on the file named '''''launch.bat''''',
+
** Using Linux: use your terminal tool to launch the file named '''''launch.sh''''' (i.e. first make sure that the file has at least the execution right on your system using this command: '''''chmod +x launch.sh''''', then type in your terminal tool: '''''sh launch.sh'''''),
+
** Using MacIntosh: double-click on the file named '''''APE_data_preparation_tool-jar-with-dependencies.jar'''''.
+
 
+
* At the first launch of the tool, a dialogue box will appear, asking first for your country code (2-letter country code, in capital characters, compliant to the [https://en.wikipedia.org/wiki/ISO_3166 iso3166 standard]), then for an identifier for your archival institution: please enter your registered [https://en.wikipedia.org/wiki/International_Standard_Identifier_for_Libraries_and_Related_Organizations ISIL-code identifier] (if you have one, else you will still need to enter a valid iso15511 standard code).
+
 
+
[[File:APE_DPT_manual_02.png|400px|thumb|left|APE DPT manual, figure 2, entering a country code ("NL" for: The Netherlands)]]
+
<br clear=all>
+
 
+
[[File:APE_DPT_manual_03.png|400px|thumb|left|APE DPT manual, figure 3, entering an ISIL code ("NL-HaNA" for Nationaal Archief (National Archives), The Hague)]]
+
<br clear=all>
+
 
+
''The iso15511 standard consists of up to 14 characters, usually starting with a two-letter country code (or a one-three- of four-letter organisational code), followed by a hyphen, followed by an alphanumeric code for the single institution. The latter can contain the digits 0 to 9, the characters A to Z and the characters -, / or \.''
+
 
+
''Note: you can change these identifiers anytime you want via the options section of the tool.''
+
 
+
* The program should now be running (see figure 4 below), if that’s not the case, please refer to the troubleshooting section of this manual.
+
* The folder now contains four folders (named: '''''apeoptions''''', '''''lib''''', '''''output''''' and '''''xsl''''') and six files.
+
 
+
[[File:APE_DPT_manual_04.png|400px|thumb|left|APE DPT manual, figure 4, the 'homepage' of the DPT, the 'Summary' tab is activated by default]]
+
 
+
 
+
[[Category:Tools_DPT_manual]]
+

Latest revision as of 09:10, 28 October 2022

The content of this page has been integrated into the website of Archives Portal Europe now.