DAITSS Demo Virtual Machine Quick Start Guide

Transcription

1 DAITSS Demo Virtual Machine Quick Start Guide The following topics are covered in this document: A brief Glossary Downloading the DAITSS Demo Virtual Machine Starting up the DAITSS Demo Virtual Machine A tour of the DAITSS Demo Virtual Machine First-time login to the DAITSS Workflow Interface Submitting a Sample SIP Submitting a batch of SIPs Submitting an invalid SIP Disseminating an AIP from the repository Withdrawing an AIP from the repository DAITSS fixity checking processes Advanced operations in the DAITSS Demo Introduction This Guide will take you through the installation of the DAITSS Demo Virtual Machine and a series of guided tasks that will briefly lead you through all of the key operations functions of DAITSS Open Source Software. Full details about DAITSS are provided in the DAITSS Operations Manual available at Brief Glossary DAITSS Demo Virtual Machine (VM): A fully self-contained Virtual Machine (VM) demonstration instance of DAITSS that will enable you to view and use a demonstration instance of DAITSS software on your local desktop. The DAITSS Demo Virtual Machine contains a demonstration desktop as well as a DAITSS instance and simulates a DAITSS Operator s desktop and DAITSS User Interface browsers. Archival Information Package (AIP): The contents of a Submission Information Package (SIP), plus any saved transformed versions of any of the content files in the SIP, plus all of the metadata pertaining to these objects stored in the DAITSS digital archive. Page 1

2 Content file: A data object that is the target of preservation. Content files are contained in Submission Information Package directories, and are described in the Descriptor file of the Submission Information Package (SIP). Descriptor file: An xml document in METS format containing preservation description Information. It serves as a packing slip or manifest to indicate who is submitting content for archiving and lists details about each of the content files submitted for archiving. Dissemination Information Package (DIP): The data files belonging to a single AIP that are exported from DAITSS to the owner upon request. A DIP will always include the contributed content files and may include transformed versions of the contributed content files. Intellectual Entity: Something that can reasonably be described and used as a unit, and corresponds roughly to what might be described by a bibliographic record: a book, a sound recording, a photograph. Intellectual Entity ID (IEID): A unique identifier assigned by DAITSS for every Submission Information Package (SIP) submitted to DAITSS. Package: An information package, usually consisting of one or more data files and a container folder or directory. This is a generic term that can be applied to a Submission Information Package (SIP), an Archival Information Package (AIP), or Dissemination Information Package (DIP), each of which has a more specific definition. Submission Information Package (SIP): A SIP is defined in the Open Archival Information standard (OAIS) as an information package delivered to a repository for archiving. For submission to the Florida Digital Archive, a SIP must follow certain rules, outlined below. The FDA recommends that a SIP contain only one Intellectual Entity. Downloading the DAITSS Demo Virtual Machine Before you can use the DAITSS Demo, you must install a VMWare Player and download the DAITSS Demo Virtual Machine file to your desktop, as follows: Download and install the VMWare Player on your workstation. A link provided on the Download page of the DAITSS website ( This player will enable you to run the DAITSS Virtual Machine on your local workstation. (You may need to reboot your workstation after this step.) Download and unzip the DAITSS Demo Virtual Machine to your workstation from the link provided on the Download page of the DAITSS website ( [exact link will be given when it s done] Starting up the DAITSS Demo Virtual Machine To start up the DAITSS Demo Virtual Machine: Recommended: close all other applications on your desktop, as the DAITSS demo is quite resourceintensive. Page 2

3 Open the VMWare Player you ve installed on your desktop. In your VMWare Player window, select the Open a Virtual Machine option and select the DAITSS Demo.vmx file in the DAITSS Demo.vmwarevm directory on your workstation and click Open. Page 3

4 The following VMWare Player message may appear. If so, click Take Ownership : Under the DAITSS Demo virtual machine, click Play virtual machine The following DAITSS Demo - VMware Player message may appear, if so, click I copied it Page 4

5 The following message may appear, if so, click Remind Me Later Log into the DAITSS Demo Virtual Machine as the user daitss and the password daitss, then click the Log In button: Page 5

6 A Tour of the DAITSS Demo Virtual Machine The demonstration desktop The DAITSS Demo Virtual Machine contains the following components: A demonstration desktop that simulates a DAITSS Operator s workstation. (Note that the DAITSS Demo Virtual Machine uses only this desktop and does not access your workstation s actual desktop.) A running instance of a DAITSS server that contains a complete set of DAITSS software components as described in Chapter 3 of the DAITSS Operations Manual. A running instance of a Firefox browser that accesses DAITSS user interfaces as described in Chapters 6 and 7 of the DAITSS Operations Manual. A sample-packages folder: that includes.zip files of Valid SIPs and Invalid SIPs that can be submitted for archiving. A DAITSS-reports folder that contains a copy of the stylesheet (daitss_report_xhtml.xsl) for rendering DAITSS reports and an Ingest Report for a sample package. A Disseminated-packages folder that contains a sample DAITSS Dissemination Information Package (DIP) The sample-packages folder The sample-packages folder on your DAITSS Demo desktop contains two sets of Submission Information Packages (SIPs) that can be used for submission to DAITSS via the DAITSS Workflow Interface: Page 6

7 The Valid SIPs folder contains a set of SIPs that conform to DAITSS SIP specifications and can be successfully archived into the DAITSS Demon VM: The Invalid SIPs folder contains a set of SIPs that do not conform to DAITSS SIP specifications and will cause error messages upon submission: Page 7

8 Viewing the contents of a SIP To view the contents of a sample SIP, double-click on one of the SIPs in the sample-packages directories on your DAITSS Demo desktop to display the contents of the zipped folder: Page 8

9 Note that all valid DAITSS SIPs have the following characteristics: They are contained in a folder. (For submission via the DAITSS Workflow Interface the folder must be in.zip or.tar format.) The folder contains the documents or images to be archived. The folder also contains a SIP Descriptor file, a sort of manifest that lists all files to be archived, that includes descriptive metadata about the intellectual entity, and includes the DAITSS Account and Project to which the package should be archived. For complete DAITSS SIP specifications please refer to Chapter 5: The DAITSS Archiving Process of the DAITSS Operations Manual available at The DAITSS-reports folder The DAITSS-reports folder contains the stylesheet necessary for rendering DAITSS processing reports (daitss_report_xhtml.xsl) and a sample DAITSS dissemination report that corresponds to the package named sample that has been preloaded into the DAITSS Demo Virtual Machine (EHS952QFO_OG1LJR.xml). The Disseminated-packages folder The Disseminated-packages folder on the DAITSS Demo desktop contains an example of a DAITSS Dissemination Information Package (DIP). First-time login to the DAITSS Workflow Interface To log in to the demonstration DAITSS Workflow Interface as a DAITSS Operator User, double-click on the Firefox browser icon on your DAITSS Demo Virtual Machine desktop. The browser will automatically load the DAITSS Workflow Interface ( A login screen will be displayed. Use the default Operator User: daitss and password: daitss for first-time login and click login : (Hint: you may want to adjust your DAITSS Demo Virtual Machine resolution by changing the System -> Preferences -> Display settings at the top of the DAITSS Demo screen until the DAITSS Workflow Interface display is adjusted to your local workstation s monitor resolution.) Page 9

10 Viewing the sample Archival Information Package (AIP) The DAITSS Demo Virtual Machine is supplied with one Archival Information Package (AIP) named sample already included. To view the sample AIP, click on the packages tab of the DAITSS Workflow Interface s Operator s Toolbar at the top of the DAITSS dashboard page: For a complete tour of the DAITSS Operator s Toolbar please see Chapter 6: DAITSS Workflow Interface in the DAITSS Operations Manual ( The packages page The packages page contains three sections: submit, search, and at the bottom a display of the most recently processed packages in the DAITSS system. You will see the sample package displayed at the bottom: Page 10

11 You will need to clear the start date and hit enter to show the packages. The packages in the DAITSS demo VM were loaded on 12/23/2013. Click on the Intellectual Entity ID (IEID) link for EHS952QFO_OG1LJR and it will display the package details page for this AIP: Page 11

12 Page 12

13 Submitting a Sample SIP This exercise will lead you through the process of submitting a single Submission Information Package (SIP) via the DAITSS Demo Workflow Interface. Subsequent exercises will enable you to work with that package in various ways that will demonstrate DAITSS functionality. To access the SIP submission function, click on the packages tab in the Operator s Toolbar at the top of the page: This will take you to the packages page: In the submit portion of the page, click the Browse button Double-click on the Desktop folder Double-click on the sample-packages folder Double-click the valid SIPs folder Select the ateam.zip file Click Open : Page 13

14 Then click on the Submit button in the DAITSS Workflow Interface. After a few moments you should see the following screen that displays the successful submission of the ateam SIP: (Note that the Intellectual Entity ID (IEID) assigned to your package will be a unique 16-character identifier and will differ from the IEID in the example above.) Refreshing the browser window, either by using the browser refresh button or by pressing F5, will display detailed information about the processing of the SIP and subsequently the archived demo package: Page 14

15 Page 15

16 Downloading the Ingest Report In the aip section, click on the link to the ingest report and select Save File and click OK: Under Places, double-click Desktop Double-click the DAITSS-reports folder on your DAITSS Demo VM desktop Click Save to save the ingest report there. (That folder already contains the stylesheet necessary to render the report.) Next, minimize your browser and double-click to open the DAITSS-reports folder on your DAITSS Demo VM desktop Double-click on the XML ingest report file to view it. Please note that the file is name <IEID>.xml. Page 16

17 Clicking on the DAITSS Ingest Report for the ateam sample package will display details about the SIP and its ingest into the DAITSS repository: Page 17

18 Viewing the Ingest Report from the GUI To view the ingest report from the GUI click on ingest report. Viewing an AIP in DAITSS Archival Storage To view the ateam Archival Information Package (AIP) in the DAITSS Demo Archival Storage, open a new tab and browse to the DAITSS StorageMaster URL, Click on the Manage link to see which DAITSS Storage Silos have been assigned to this repository: Page 18

19 Note that only one DAITSS Storage Silo has been assigned to the Demo repository, silo.shades.local. To view the Storage Silo: Open a new browser tab and browse to the DAITSS Silo Management interface URL, Then click on the Manage link This will display the DAITSS Archival Storage silo assigned to the DAITSS Demo instance and its contents. Click on the list packages link will display all packages stored on this silo. Note that there are 3 Packages in the silo, the sample package, the ateam package you have just archived and another sample package that has been disseminated. In IEID column, click on the IEID (Intellectual Entity ID) of the package you ve just archived to view the Archival Information Package (AIP) in DAITSS Archival Storage: Page 19

20 Clicking on the individual files under File Name will display them. This AIP has the following contents: descriptor.xml: the PREMIS-in-METs AIP descriptor for this Archival Information Package. A /sip-files directory containing the original Submission Information Package (SIP) contents. In this case there are two files: ateam.tiff, an image submitted for archiving ateam.xml, the SIP descriptor file required in each SIP xmlres-0.tar: a tarfile of all schema files downloaded by the DAITSS xmlresolution service during archiving of this package. Disseminating a Sample SIP To disseminate a SIP from the DAITSS Demo repository, return to the DAITSS Workflow Interface ( From the packages tab: Under the search section type ateam in the search input box Then click on Search : Page 20

21 Next, click on the unique Intellectual Entity ID (IEID) to view the Package Details page for ateam : At the bottom of the screen you will see the submit request section. Type a note in the text input box. A note is required for all requests. Click on the Request button to initiate a dissemination request. The Package Details page for ateam will now display the dissemination request and the dissemination request placed event in the events section of the display: Page 21

22 Refreshing the page will show the progress of the dissemination request. When the dissemination is finished a link to the Dissemination Information Package (DIP) will appear in the dips section at the bottom of the page: Page 22

23 Click on the link below dips and select Save File and click OK : Page 23

24 Double-click the Desktop folder Double-click the Disseminated Packages folder Click Save From the Disseminated Packages folder on the DAITSS Demo desktop you can view the contents of the DIP: Page 24

25 Note that the DIP will always contain the xmlres-0.tar file of all schemas downloaded during the initial ingest, along with the most recent xmlre.tar file (in this case xmlres-1.tar) downloaded during the re-ingest of the package that constitutes part of the DAITSS dissemination process. Now you can repeat the above steps with any of the sample packages provided in the sample-packages directory on the DAITSS Demo Virtual Machine s desktop. Submitting a batch of SIPs via the command line DAITSS also allows submission of batches of SIPs in one operation from the command line of the DAITSS repository server. To simulate this operation in the DAITSS Demo Virtual Machine: Click on the Terminal icon on your DAITSS Demo desktop and cd to the /var/daitss/sample-packages directory to see the two folders of SIPs available for batch submission, valid_sips and invalid_sips: To submit the all of the SIPs in the valid_sips folder, issue the following command that will also create a DAITSS batch (or list) for ease of tracking: submit - username daitss - password daitss - path /var/daitss/samplepackages/valid_sips - note This is a test batch submission - batch valid_sips Viewing your batch in the DAITSS Workflow Interface To view the batch you ve just submitted, click on the batches tab in the DAITSS Workflow Interface. You will see a listing for your valid_sips batch: Click on the batch name to see a complete list of packages in your batch, along with their current processing status: Page 25

26 Clicking on the IEID of a specific package will display complete package details. Submitting an Invalid SIP While nobody intends to submit invalid SIPs, DAITSS retains records of all submitted SIPs, whether they successfully pass the submission process or are rejected as invalid. To see an example of how DAITSS deals with invalid SIPs: From within the packages tab of the DAITSS Workflow Interface, click on Browse under the submit portion of the screen. Select one of the SIPs in the Invalid SIPs folder on your DAITSS Demo desktop and click Open : Page 26

27 Then double-click on the submit button. After a moment the interface will display the results of the submission: Note that the DAITSS Preservation Database will retain a permanent record of this failed submission attempt. Running fixity checks on your DAITSS Demo Virtual Machine After packages are archived in DAITSS Archival Storage, fixity checking scripts are run in the background on a regular basis (see Chapter 8? for details). On the DAITSS Demo Virtual Machine these scripts are set to run nightly at 1:01am (disk-fixity) and 2:01am (collect-fixities). The logs are kept in /var/log/daitss/daemons, accessible from the Terminal icon on the DAITSS Demo desktop. To allow the DAITSS Demo Virtual Machine fixity scripts to run, you must leave your VMWare window up overnight, with the DAITSS Demo running. The following morning you will be able to see the results of these scripts in both the DAITSS Workflow Interface (for individual AIPs) and the DAITSS Silo Management Interface (for an entire DAITSS Archival Storage silo and its contents). Page 27

28 Viewing fixity checks via the DAITSS Silo Management Interface Point your DAITSS Demo Virtual Machine s FireFox browser at where you ll see the column heading Most Recent Package Fixities (earliest/latest) column and timestamps indicating the earliest fixity check timestamp and latest fixity check timestamp for packages on that silo: Clicking on the fixity xml link will display a full list of AIPs on that silo along with details of their most recent fixity check. Viewing fixity checks via the DAITSS Workflow Interface To view fixity checking information about a specific package, search for the package via the DAITSS Workflow Interface, and click on its Intellectual Entity ID (IEID) to display its Package Details Page: Withdrawing a package from the repository To withdraw your ateam package from the DAITSS Demo Virtual Machine repository: Locate the ateam package in the DAITSS Workflow Interface and click on the Intellectual Entity IED (IEID) number to display its Package Details page: Page 28

29 Find the submit request section of that page, select withdraw from the pull-down menu, and add a note (required). Then click the Request button. Note that the withdrawal request is now displayed in the requests section of the page: The withdrawal request is now in an unauthorized state. DAITSS requires that withdrawals from the repository be authorized by a second DAITSS Operator User, to prevent accidental withdrawals from the repository. Note that the withdrawal request can be cancelled at this stage. Page 29

30 Advanced operations on the DAITSS Demo Virtual Machine Once you ve mastered these very basic operations on the DAITSS Demo Virtual Machine, you can perform more advanced operations on the DAITSS Demo. Some suggested advanced operations: Use the information in Chapter 2 of the DAITSS User Guide (Getting Started) to create additional DAITSS Accounts, Projects, and Users. Create SIPs for archiving in your new Account by copying an modifying one of the sample SIPs provided. To create your own SIP: right-click and extract one of the SIPs in the Valid SIPs folder, change the ACCOUNT= (and PROJECT= ) information in the descriptor file save the descriptor and moving the folder to a new directory on the DAITSS Demo desktop right-click and compress the folder in.zip format Submit the new SIP following the steps illustrated above. For more detailed information about DAITSS software, please consult the DAITSS Operations Manual found on the Documentation page of the DAITSS website, Page 30