Difference between revisions of "Installation/Quick Start Guide"

Revision as of 13:19, 12 May 2015

Download PDF version of the DAFv2 Quick Start Guide
This document is intended for a quick start on the DAFv2 System after it has been successfully installed. This is mainly a walkthrough the system configurations in a step-by-step way. It is recommended to apply this document to your system before starting to distribute the client on your digital lab machines.

Start and Login

1. Start DAFv2 by double clicking on the DAFv2.jar or by typing from within the $DAF_HOME directory java –jar DAFv2.jar
2. In the login screen login using Username: root and Password: DAFroot
3. An error message will appear to declare that your machine is not registered, press the “OK” button.

Adjust the Roles

After you login successfully, you are supposed to see the Roles Manager Screen, we will add some default Roles, for more details about the Roles please consult the User Manual.

1. Click on “Create a New Role” button.
2. In the Role Name type: “Administrator”
3. From the Available Privileges Check “Permissions” and make sure all permissions tree are selected.
4. Then click on the “Create” button.
5. Click on “Create a New Role” button.
6. In the Role Name type: “Shift Operator”
7. From the Available Privileges Check Everything except the “AdminManager” and make sure all the rest permission trees are selected.
8. Then click on the “Create” button.
9. Click on “Create a New Role” button.
10. In the Role Name type: “Simple User”
11. From the Available Privileges Check “PhaseManager” and make sure all the permission sub-tree is selected.
12. Then click on the “Create” button.
13. Select the root account in the “Current Available Roles”.
14. From the Available Privileges Check “Permissions” and make sure all permissions tree are selected.
15. Then Click “Update” button.
16. Disconnect and re-connect with the user root.

Adjust_Some_General_Settings

1. Click on the General Settings tab.
2. From the “General” drop down list, select “Storage”. (this declares your production ftp server).
3. Click on the “Create New” button.
4. Fill the fields as follow:
   FTP IP: the name or IP of the ftp server you are using
   User Name: the ftp login name
   Password: the ftp login password
5. Click on the “Create” button.
6. From the “General” drop down list, select “Job Condition”.
7. Click on the “Create New” button.
8. Type “Good” in the “Name” field.
9. Click on the “Create” button.
10. Repeat steps from 7 till 9 and use “Bad” instead of “Good” in the Name field.
11. From the “General” drop down list, select “Operating System”.
12. Click on the “Create New” button.
13. Type “Microsoft Windows” in the “Name” field.
14. Click on the “Create” button.
15. Repeat steps from 12 till 14 and use “Linux” instead of “Microsoft Windows” in the Name field.
16. (The default installation of the system comes with default Medias, please skip steps 16 till 18 if it is already created) From the “General” drop down list, select “Media Type”.
17. Fill the fields as follow:
    Name: CD
    Abbreviation: CD
    Size: 700
    Starting Barcode: 1
18. Click on the “Create” button.

Create a new Job-Type

We will create a simple Job-Type, please refer to the User Manual for more Job-Types creation.

1. Click on the “Job-Types” tab.
2. Click on Create a New Job-Type button.
3. In the “Job-Type Name” type “Book”
4. In the “Maximum Life Time” type 15
5. The “Job Folder Naming Convention” type BookName
6. From the “Media Types” select “CD”.
7. Click on the “Create” button.

Create some sample Phases

We will create 3 sample phases for the “Book” Job-Type.

1. Click on the “Phases” tab.
2. Select “Book” from the “Job-Types” drop down menu.
3. Click on “Create New Phase” button.
4. Fill the fields as follow:
   Phase Name: Scanning
   Maximum Period: 5 days
   XML Description:
   <Phase Name="Scanning"><PrePhase><Physical Mode="Unrestricted"><Folder Name="OTIFF" Create="true" ToDestination="false" NewName="OTIFF" Mode="Unrestricted"/></Physical></PrePhase><PostPhase><Physical Mode="Unrestricted"><Folder Name="OTIFF" Create="false" ToDestination="true" NewName="OTIFF" Mode="Restricted"><File Name="Local_OriginalFiles" Type="tif" Count="+" ToDestination="true" Compare="" CheckName="true"/></Folder></Physical></PostPhase></Phase>
5. Click on the “Create”
6. Repeat steps from 3 to 5 while replacing the field values with:
   Phase Name: Processing
   Maximum Period: 5 days
   XML Description:
   <Phase Name="Processing"><PrePhase><Physical Mode="Unrestricted"><Folder Name="OTIFF" Create="true" ToDestination="false" NewName="OTIFF" Mode="Restricted"><File Name="Server_OriginalFiles" Type="tif" Count="+" ToDestination="true" Compare="" CheckName="true"/></Folder><Folder Name="PTIFF" Create="true" ToDestination="false" NewName="PTIFF" Mode="Unrestricted"/></Physical></PrePhase><PostPhase><Physical Mode="Unrestricted"><Folder Name="PTIFF" Create="false" ToDestination="true" NewName="PTIFF" Mode="Restricted"><File Name="Local_ProcessedFiles" Type="tif" Count="+" ToDestination="false" Compare="Server_OriginalFiles" CheckName="true"/></Folder></Physical></PostPhase></Phase>
7. Repeat steps from 3 to 4 while replacing the field values with:
   Phase Name: OCRing
   Maximum Period: 6 days
   XML Description:
   <Phase Name="OCRing"><PrePhase><Physical Mode="Unrestricted"><Folder Name="PTIFF" Create="false" ToDestination="true" NewName="PTIFF" Mode="Restricted"><File Name="Server_ProcessedFiles" Type="tif" Count="+" ToDestination="true" Compare="" CheckName="true"/></Folder><Folder Name="TXT" Create="true" ToDestination="false" NewName="TXT" Mode="Unrestricted"/></Physical></PrePhase><PostPhase><Physical Mode="Unrestricted"><Folder Name="TXT" Create="false" ToDestination="true" NewName="TXT" Mode="Unrestricted"></Folder></Physical><Database><Field Name="Font" DisplayName="Font Family" PredefinedValues="None;AR-H1;AR-H2;AR-H3;AR-M4;AR-L4;AR-H4;DT-M1;DT-L2;TA-H1;TA-H2;TA-H4;TA-L4;TA-L1;TA-M4;TA-M2;6 Tashkel;X" Mandatory="true" /><Field Name="LearningPage1" DisplayName="Learning Page 1" PredefinedValues="" Mandatory="true" /><Field Name="LearningPage2" DisplayName="Learning Page 2" PredefinedValues="" Mandatory="false" /><Field Name="LearningPage3" DisplayName="Learning Page 3" PredefinedValues="" Mandatory="false" /><Field Name="TestPage1" DisplayName="Test Page 1" PredefinedValues="" Mandatory="true" /><Field Name="AccuracyBefore" DisplayName="Accuracy Before" PredefinedValues="" Mandatory="true" /><Field Name="AccuracyAfter2" DisplayName="Accuracy After Page 2" PredefinedValues="" Mandatory="false" /><Field Name="AccuracyAfter3" DisplayName="Accuracy After Page 3" PredefinedValues="" Mandatory="false" /></Database></PostPhase></Phase>
8. Using the “>”, “<”, “up” and “down” arrows order the Phases in the Assigned Sequence list to be as follow:
   Scanning
   Processing
   OCRing
   Backup
   
9. Press on the “Update Sequence” button. (Note the quick backup should not be in the Assigned list).

Adding Users to the System

We will create some sample users with different roles.

• Simple User 1:

1. Click on the “Users” tab.
2. Click on “Create User” button.
3. Fill the fields as follows:
   User Name: User1
   Password: User1
   Assigned Role: select “Simple User” option from the drop down list.
   Maximum Jobs: 2
   Assigned Phases: Fill this list from the “Available Phases” list. In the “Available phases” list double click the “Book” job type, a sub-tree of 3 phases (Scanning-Processing-OCRing) appears. Select the Scanning and Processing Phases. Using the ‘>’ arrow fill the “Assigned Phase” list with these selected phases.
4. Do not check the Is-LDAP check box.
5. Click the “Create” button.

• Simple User 2:
  Repeat the same steps mentioned in Simple User 1, selecting the “OCRing” phase only from the “Available Phases” and “User2” as User Name and Password instead of “User1”.
  

In addition to these two simple users, create an Administrator and Shift Operator Users

• Administrator:

1. Click on “Create User” button.
2. Fill the fields as follows:
   User Name: Administrator
   Password: Administrator
   Assigned Role: select “Administrator” option from the drop down list. Maximum Jobs: 100
   Assigned Phases: Fill this list from the “Available Phases” list. In the “Available phases” list select the “Book” job type and press the “>” arrow. The “Assigned Phase” list is filled with the three phases (Scanning-Processing-OCRing).
3. Do not check the Is-LDAP check box.
4. Click the “Create” button.

• Shift Operator:

1. Click on “Create User” button.
2. Fill the fields as follows:
   User Name: ShiftOperator
   Password: ShiftOperator
   Assigned Role: select “Shift Operator” option from the drop down list. Maximum Jobs: 100
   Assigned Phases: Fill this list from the “Available Phases” list. In the “Available phases” list select the “Book” job type and press the “>” arrow. The “Assigned Phase” list is filled with the three phases (Scanning-Processing-OCRing).
3. Do not check the Is-LDAP check box.
4. Click the “Create” button.

Please refer to the User Manual for more about the User Roles.

Adding Workstations

We will add 2 workstations as a sample, one for Scanning and Processing and the other is for OCRing of the Job Type “Book”.

• Workstation 1:

1. Click on “Create WorkStation” button.
2. Fill the fields as follows:
   Name: the machine name you are currently using in this guide, without the domain name, or its IP if it has a fixed one. Referred to in this document as Workstation1
   Location: Digital Lab
   Operating System: Microsoft Windows XP Prof
   Working Directory: D:\User Data\$username$\DAF (or any other folder of your choice, please not that $username$ is replaced with the logged-in user name at runtime).
   Assigned Phases: Fill this list from the “Available Phases” list. In the Available phases” list double click the “Book” job type, a sub-tree of 3 phases Scanning-Processing-OCRing) appears. Select the Scanning and Processing Phases. Using the ‘>’ arrow fill the “Assigned Phase” list with these selected phases.
   Media Types: CD
3. Click the “Update” button.

• Workstation 2:

1. Click on “Create WorkStation” button.
2. Fill the fields as follows:
   Name: the name of any machine accessible into your network you are, without the domain name, or its IP if it has a fixed one. Referred to in this document as Workstation2
   Location: Digital Lab
   Operating System: Microsoft Windows XP Prof
   Working Directory: D:\User Data\$username$\DAF (or any other folder of your choice, please not that $username$ is replaced with the logged-in user name at runtime).
   Assigned Phases: Fill this list from the “Available Phases” list. In the Available phases” list double click the “Book” job type, a sub-tree of 3 phases Scanning-Processing-OCRing) appears.
   Select the “OCRing” Phase. Using the ‘>’ arrow fill the “Assigned Phase” list with this selected phase.
   Media Types: CD
3. Click the “Update” button

Adding Collections

Before creating any collection, explicitly add in Metadata DB the Owner, Project and In-Charge for this collection. For example, add the Owner ‘Bibliotheca Alexandrina’, Project ‘Million Book Project and In-Charge ‘BA-Library Service’.

1. Click on the button “Create Collection”.
2. Fill the fields as follows:
   Collection Name: MyCollection
   Owner: Select from the drop down list “Default” (or any added Owner from the Metadata DB)
   Project: Select from the drop down list “Default” (or any added Project from the Metadata DB)
   In-Charge: Select from the drop down list “Default” (or any added InCharge from the Metadata DB)
   Default Path: MyColl
   Collection Abbreviation: MCOL
   Priority: 10
   Attached Users: Fill this list from the “Available Users” list. In the Available Users” list double click the “Simple User”, a sub-tree of the 2 previously created simple users appears(User 1, User 2). Select the 2 users. Using the ‘>’ arrow fill the “Assigned Phase” list with this selected phase. Similarly add the “Administrator” and the “Shift Operator” users.
   Workstations: The Workstations are listed in the “Workstations” list, beside a check box. Check the boxes of WorkStation1 and WorkStation2.

Create a new Batch

1. Login into the system using the “ShiftOperator” user.
2. From the Views menu, select the “Check-In Manager”
3. Make sure that the Batch tab is selected.
4. Click on “Add Batch” button.
5. Fill the fields as follow:
   Batch Name: First Batch
   Comment: Pilot Batch from Quick Start Guide.
   Collection: MyCollection
   Job Type: Book
6. Click on the “Save” button.

Adding a Job Into the System

1. Before adding a new Job into the system, restart the application, and make sure that the error message declaring that the machine is not registered does not appear.
2. You must login either using the “Administrator” to the “ShiftOperator” user.
3. From the Views menu, select the “Check-In Manager”
4. Then select the New Job tab.
5. Fill the fields as follow (the rest of the fields are optional):
   Title: First Book
   Language: English
   Priority: 10 (recommended)
   Collection: MyCollection
   Batch: First Batch
   Job Condition: Good
   Server: please select the server you configured in point 3.a
   Job Type: Book
6. Click on the “Add” button, as well as the confirmation message. Please note that the newly created Job ID in the system is declared in the confirmation message.

Scanning the Job

1. Login into DAFv2 using “User1”
2. From the Views menu, select the “Phase Manager”
3. Click on “Get Job” button.
4. Select the newly created job from the list that appeared, then click on the “Select Job” button.
5. Open the directory “D:\User Data\User1\DAF” on your machine.
6. You will find a folder called “00000001”, inside that folder you will find an empty “OTIFF” folder.
7. Add some tiff files to this folder such that the filenames are “00000001-0001.tif” and so on (following a pattern consisting of the 8digitsJobPath-4digitsfileNumberSequence.tif)
8. Close this folder.
9. Go back to DAFv2 client, select the Job from the list, then click on the “Done” button.

Monitor the Job in the Workflow report

1. Login into DAFv2 using “ShiftOperator” or “Administrator”
2. At any time you can monitor the state of you Jobs in the System using the Workflow report even if the Jobs are currently started.
3. From the Views menu, select the “Reporting Manager”
4. Make sure that the selected tab is the “Workflow Report” tab.
5. Click on the “Submit” button, currently you will find your Job in the “Scanning”,”Done” cell.

Processing the Job

1. Login into DAFv2 using “User1”
2. From the Views menu, select the “Phase Manager”
3. Click on “Get Job” button.
4. Select the newly created job from the list that appeared, then click on the “Select Job” button. Please not that the “Next Phase” column this time indicates “Processing”.
5. Open the directory “D:\User Data\User1\DAF\00000001” on your machine.
6. Inside that folder you will find a folder “OTIFF” (with file submitted earlier), and an empty folder “PTIFF”.
7. Copy the files from the “OTIFF” folder into the “PTIFF”, then do some processing on them if necessary (on the files in the “PTIFF” folder).
8. Close this folder.
9. Go back to DAFv2 client, select the Job from the list, then click on the “Done” button.

OCRing the Job

1. Now move to Workstation2
2. Copy the DAFv2 binary folder to Workstation2
3. Login into DAFv2 using “User2”
4. From the Views menu, select the “Phase Manager”
5. Click on “Get Job” button.
6. Select the newly created job from the list that appeared, then click on the “Select Job” button.
7. Open the directory “D:\User Data\User2\DAF\00000001” on your machine.
8. Inside that folder you will find a folder “OTIFF”, a folder “PTIFF” (with file submitted earlier) and a new folder “TXT”.
9. Create some files (the output of the OCR phase) and add them to the newly create “TXT” folder.
10. Close this folder.
11. Go back to DAFv2 client, select the Job from the list, then click on the “Done” button.

Backup the Job

1. Login into DAFv2 using “ShiftOperator” (using either Workstation1 or Workstation2)
2. From the Views menu, select the “Phase Manager”
3. Click on “Get Job” button.
4. Select the newly created job from the list that appeared, then click on the “Select Job” button.
5. Select the Job from the list, then click on the “Done” button. (Nothing is to be done by the User at all).

Archiving the Job

In order to archive Job you must define the archiving medias that Job type of this job should be archived on, also, you must declare a workstation as archiver workstation. These configurations must be done before archiving process itself.

1. Configure Job Type and Media Type
   1. Login to DAFv2 as administrator
   2. Select Admin Manager from Views, then select Job Types tab.
   3. Choose the Job Type that you need to set its archiving medias
   4. Select Media(s) from media check list (bottom side)
   5. Click on “Update” button
2. Configure Workstation
   1. Login to DAFv2 as administrator
   2. Select Admin Manager from Views, then select Workstations tab.
   3. Choose the Workstation that you need to set as archiver machine
   4. Select Media(s) from media check list (right side)
   5. Click on “Update” button
3. Archive a Job
   1. Login to DAFv2 as user have archiving permission
   2. Select Archiving Manager from Views, then select Archiver tab.
   3. Choose the Media that you need to archive data on, from the drop down list
   4. Select Jobs to be archived
   5. Make sure the size bar is not (red) which means oversized media
   6. Click on “Archiver” button
   7. Wait for the progress bar to be completed
   8. A confirmation dialog box will be shown after process is completed, click on “Confirm” or “Discard” to confirm or deny the formed media.
   9. On the working directory of the current workstation you will find a formed folder with media barcode, you should burn/write it to physical media.
4. Confirm Job
   1. After finishing writing the Media folder to its physical destination (CD, DVD, Tape, …) go to Confirm Media tab.
   2. Select the written Media.
   3. Click “Confirm” button to finish the process.
   4. If you find there are some error in this media and you need to discard it, you should click on “Discard” button which will rollback every thing.

Checking out the Job

1. One the job has been archived on all dedicated medias (to its Job type) and the job in inactive state, then it should be ready to check out
2. Login to DAFv2 as user have Check out permission
3. Go to Archiving Manager -> Archived And Active tab
4. Select the Job to be checked out, and make sure the Active value associated with is “0” (for inactive job)
5. Click on “Check Out” button.
6. If the job hasn’t fulfilled the archiving matrix (Revise DAFv2 documentation, Archiving manager module) a dialog of forced check out will be shown. Forced check out can check out inactive jobs that don’t complete the archiving matrix.