DARAdministratorDAF at 08:32, 13 May 2015

2015-05-13T08:32:29Z

DARAdministratorDAF at 13:20, 12 May 2015

2015-05-12T13:20:16Z

DARAdministratorDAF at 13:19, 12 May 2015

2015-05-12T13:19:42Z

DARAdministratorDAF: Administrator moved page Quick Start Guide to Installation/Quick Start Guide

2015-05-12T13:18:14Z

Administrator moved page Quick Start Guide to Installation/Quick Start Guide

DARAdministratorDAF: Installation/Quick Start Guide

2015-05-12T13:17:34Z

Installation/Quick Start Guide

New page

[[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 ==

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

== Adjust the Roles ==

<hr />
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.

<ol><li>Click on “Create a New Role” button.
</li><li>In the Role Name type: “Administrator”
</li><li>From the Available Privileges Check “Permissions” and make sure all permissions tree are selected.
</li><li>Then click on the “Create” button.
</li><li>Click on “Create a New Role” button.
</li><li>In the Role Name type: “Shift Operator”
</li><li>From the Available Privileges Check Everything except the “AdminManager” and make sure all the rest permission trees are selected.
</li><li>Then click on the “Create” button.
</li><li>Click on “Create a New Role” button.
</li><li>In the Role Name type: “Simple User”
</li><li>From the Available Privileges Check “PhaseManager” and make sure all the permission sub-tree is selected.
</li><li>Then click on the “Create” button.
</li><li>Select the root account in the “Current Available Roles”.
</li><li>From the Available Privileges Check “Permissions” and make sure all permissions tree are selected.
</li><li>Then Click “Update” button.
</li><li>Disconnect and re-connect with the user root.
</li></ol>

== Adjust_Some_General_Settings ==

<hr />
<ol><li>Click on the General Settings tab.
</li><li>From the “General” drop down list, select “Storage”. (this declares your production ftp server).
</li><li>Click on the “Create New” button.
</li><li>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
</li><li>Click on the “Create” button.
</li><li>From the “General” drop down list, select “Job Condition”.
</li><li>Click on the “Create New” button.
</li><li>Type “Good” in the “Name” field.
</li><li>Click on the “Create” button.
</li><li>Repeat steps from 7 till 9 and use “Bad” instead of “Good” in the Name field.
</li><li>From the “General” drop down list, select “Operating System”.
</li><li>Click on the “Create New” button.
</li><li>Type “Microsoft Windows” in the “Name” field.
</li><li>Click on the “Create” button.
</li><li>Repeat steps from 12 till 14 and use “Linux” instead of “Microsoft Windows” in the Name field.
</li><li>(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”.
</li><li>Fill the fields as follow: Name: CD Abbreviation: CD Size: 700 Starting Barcode: 1
</li><li>Click on the “Create” button.
</li></ol>

== Create a new Job-Type ==

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

<ol><li>Click on the “Job-Types” tab.
</li><li>Click on Create a New Job-Type button.
</li><li>In the “Job-Type Name” type “Book”
</li><li>In the “Maximum Life Time” type 15
</li><li>The “Job Folder Naming Convention” type BookName
</li><li>From the “Media Types” select “CD”.
</li><li>Click on the “Create” button.
</li></ol>

== Create some sample Phases ==

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

<ol><li>Click on the “Phases” tab.
</li><li>Select “Book” from the “Job-Types” drop down menu.
</li><li>Click on “Create New Phase” button.
</li><li>Fill the fields as follow: Phase Name: Scanning Maximum Period: 5 days XML Description: <code><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></code>
</li><li>Click on the “Create”
</li><li>Repeat steps from 3 to 5 while replacing the field values with: Phase Name: Processing Maximum Period: 5 days XML Description: <code><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></code>
</li><li>Repeat steps from 3 to 4 while replacing the field values with: Phase Name: OCRing Maximum Period: 6 days XML Description: <code><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></code>
</li><li>Using the “>”, “<”, “up” and “down” arrows order the Phases in the Assigned Sequence list to be as follow: Scanning Processing OCRing Backup 
</li><li>Press on the “Update Sequence” button. (Note the quick backup should not be in the Assigned list).
</li></ol>

== Adding Users to the System ==

We will create some sample users with different roles. 

<ul><li>Simple User 1:
</li></ul>
<ol><li>Click on the “Users” tab.
</li><li>Click on “Create User” button.
</li><li>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.
</li><li>Do not check the Is-LDAP check box.
</li><li>Click the “Create” button.
</li></ol>
<ul><li>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”. 
</li></ul>
In addition to these two simple users, create an Administrator and Shift Operator Users

<ul><li>Administrator:
</li></ul>
<ol><li>Click on “Create User” button.
</li><li>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).
</li><li>Do not check the Is-LDAP check box.
</li><li>Click the “Create” button.
</li></ol>
<ul><li>Shift Operator:
</li></ul>
<ol><li>Click on “Create User” button.
</li><li>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).
</li><li>Do not check the Is-LDAP check box.
</li><li>Click the “Create” button.
</li></ol>
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”.

<ul><li>Workstation 1:
</li></ul>
<ol><li>Click on “Create WorkStation” button.
</li><li>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
</li><li>Click the “Update” button.
</li></ol>
<ul><li>Workstation 2:
</li></ul>
<ol><li>Click on “Create WorkStation” button.
</li><li>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
</li><li>Click the “Update” button
</li></ol>

== 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’.

<ol><li>Click on the button “Create Collection”.
</li><li>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.
</li></ol>

== Create a new Batch ==

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

== Adding a Job Into the System ==

<ol><li>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.
</li><li>You must login either using the “Administrator” to the “ShiftOperator” user.
</li><li>From the Views menu, select the “Check-In Manager”
</li><li>Then select the New Job tab.
</li><li>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
</li><li>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.
</li></ol>

== Scanning the Job ==

<ol><li>Login into DAFv2 using “User1”
</li><li>From the Views menu, select the “Phase Manager”
</li><li>Click on “Get Job” button.
</li><li>Select the newly created job from the list that appeared, then click on the “Select Job” button.
</li><li>Open the directory “D:\User Data\User1\DAF” on your machine.
</li><li>You will find a folder called “00000001”, inside that folder you will find an empty “OTIFF” folder.
</li><li>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)
</li><li>Close this folder.
</li><li>Go back to DAFv2 client, select the Job from the list, then click on the “Done” button.
</li></ol>

== Monitor the Job in the Workflow report ==

<ol><li>Login into DAFv2 using “ShiftOperator” or “Administrator”
</li><li>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.
</li><li>From the Views menu, select the “Reporting Manager”
</li><li>Make sure that the selected tab is the “Workflow Report” tab.
</li><li>Click on the “Submit” button, currently you will find your Job in the “Scanning”,”Done” cell.
</li></ol>

== Processing the Job ==

<ol><li>Login into DAFv2 using “User1”
</li><li>From the Views menu, select the “Phase Manager”
</li><li>Click on “Get Job” button.
</li><li>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”.
</li><li>Open the directory “D:\User Data\User1\DAF\00000001” on your machine.
</li><li>Inside that folder you will find a folder “OTIFF” (with file submitted earlier), and an empty folder “PTIFF”.
</li><li>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).
</li><li>Close this folder.
</li><li>Go back to DAFv2 client, select the Job from the list, then click on the “Done” button.
</li></ol>
 


== OCRing the Job ==

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

== Backup the Job ==

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


== 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.

<ol><li> Configure Job Type and Media Type
<ol><li>Login to DAFv2 as administrator
</li><li>Select Admin Manager from Views, then select Job Types tab.
</li><li>Choose the Job Type that you need to set its archiving medias
</li><li>Select Media(s) from media check list (bottom side)
</li><li>Click on “Update” button
</li></ol>
</li><li>Configure Workstation
<ol><li>Login to DAFv2 as administrator
</li><li>Select Admin Manager from Views, then select Workstations tab.
</li><li>Choose the Workstation that you need to set as archiver machine
</li><li>Select Media(s) from media check list (right side)
</li><li>Click on “Update” button
</li></ol>
</li><li>Archive a Job
<ol><li>Login to DAFv2 as user have archiving permission
</li><li>Select Archiving Manager from Views, then select Archiver tab.
</li><li>Choose the Media that you need to archive data on, from the drop down list
</li><li>Select Jobs to be archived
</li><li>Make sure the size bar is not (red) which means oversized media
</li><li>Click on “Archiver” button
</li><li>Wait for the progress bar to be completed
</li><li>A confirmation dialog box will be shown after process is completed, click on “Confirm” or “Discard” to confirm or deny the formed media.
</li><li>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.
</li></ol>
</li><li>Confirm Job
<ol><li>After finishing writing the Media folder to its physical destination (CD, DVD, Tape, …) go to Confirm Media tab.
</li><li>Select the written Media.
</li><li>Click “Confirm” button to finish the process.
</li><li>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.
</li></ol>
</li></ol>

== Checking out the Job ==

<ol><li>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
</li><li>Login to DAFv2 as user have Check out permission
</li><li>Go to Archiving Manager -> Archived And Active tab
</li><li>Select the Job to be checked out, and make sure the Active value associated with is “0” (for inactive job)
</li><li>Click on “Check Out” button.
</li><li>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.
</li></ol>

← Older revision		Revision as of 08:32, 13 May 2015
Line 1:		Line 1:
−	[[Download PDF version of the DAFv2 Quick Start Guide]]<br />	+	[[media:DAFv2-QuickStart.pdf\|Download PDF version of the DAFv2 Quick Start Guide]]<br />
	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.		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.

← Older revision		Revision as of 13:19, 12 May 2015
Line 1:		Line 1:
−	[[Download PDF version of the DAFv2 Quick Start Guide]]	+	[[Download PDF version of the DAFv2 Quick Start Guide]]<br />
	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.		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.

@@ Line 8: / Line 8: @@
 == Start and Login ==
 <ol><li>	Start DAFv2 by double clicking on the DAFv2.jar or by typing from within the $DAF_HOME directory <code>java –jar DAFv2.jar</code>
 </li><li>	In the login screen login using Username: <b>root</b> and Password: <b>DAFroot</b>
@@ Line 17: / Line 16: @@
 == Adjust the Roles ==
 <p>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.
 </p>
@@ Line 41: / Line 39: @@
 == Adjust_Some_General_Settings ==
 <ol><li>Click on the General Settings tab.
 </li><li>From the “General” drop down list, select “Storage”. (this declares your production ftp server).

← Older revision	Revision as of 13:18, 12 May 2015
(No difference)

Installation/Quick Start Guide - Revision history

DARAdministratorDAF at 08:32, 13 May 2015

DARAdministratorDAF at 13:20, 12 May 2015

DARAdministratorDAF at 13:19, 12 May 2015

DARAdministratorDAF: Administrator moved page Quick Start Guide to Installation/Quick Start Guide

DARAdministratorDAF: Installation/Quick Start Guide