• SpecifikaceTahitiDamisProtokol

Protokol je určen pro komunikaci mezi Tahiti a serverem DAMIS pro distribuci spisů k identifikaci a jejich následné předání na archivaci. Komunikace probíhá pomocí HTTP protokolu (RFC1945, RFC2616), všechny dotazy jsou z klienta na server přenášeny metodou POST.

Změny

Formát DocumentSet

DocumentSet je zazipovaný soubor, který obsahuje naskenované soubory a soubor docset.xml, který popisuje jejich atributy, příslušnost do dokumentů

Popis formátu docset.xml je dostupný zde: http://frnk.lightcomp.cz/lcdevel/SpecifikaceTahitiDamisUlozeniDat, část Popis spisu

Identifikace DocumentSetu

DocumentSet je identifikován názvem serveru a vlastním identifikátorem DocumentSetu ( id ) Oba identifikátory jsou ascii

Identifikator zámku (lockId) je textový retezec ASCII, ktery vraci server

Typická komunikace mezi Tahiti a Skenovacím serverem:

1. Tahiti dostane z dispu id DocumentSetu

2. Tahiti zamkne DocumentSet ( při této akci získá lockId)

3. Tahiti si vyžádá data DocumentSetu

4. Tahiti periodicky posílá oznámení, že má DocumentSet stále zamčen

5. Tahiti odešle zpracovaný DocumentSet

Funkce poskytované serverem:

• Uzamknutí DocumentSetu

• Oznámení, že DocumentSet byl zpracován a odeslání zpracovaného DocumentSetu ( zazipovaného )

• Oznámení, že DocumentSet zpracovávat nebude ( odemkne ho )

• Vyžádání DocumentSetu ( zazipované )

• Oznámení, že vyžádaný DocumentSet je stále používán

Data jsou přenášena pomocí http/post s content-type=text/xml

Při odesílání zpracovaného DocumentSet je použit http/post s multipart obsahem

Uzamknutí DocumentSetu

Klient odesílá

• identifikátor DocumentSetu

• uživatelské jméno

Vrátí OK, FAIL

Request
<?xml version="1.0?>
<LockRequest id="" user=""/>

Response 
<?xml version="1.0?>
<LockResponse status="LOCKED|RACE|FAIL|NOTEXISTS" lockId="" error=""/>

LOCKED - DocumentSet je uzamcen, lockId obsahuje identifikator zamku
RACE - DocumentSet ma jiz nekdo jiny uzamcen
FAIL - chyba
NOTEXIST - DocumentSet s danym id neexistuje

lockId - obsahuje přidělený kód zámku ( status == LOCKED)
error - nepovinny atribut, obsahuje blizsi popis chyby (pravdepodobne v anglictine)  

Oznámení o zpracování spisu

Zde se odesílá multipart zpráva složená ze dvou částí

1. xml s níže popsaným příkazem, název "command"

2. zazipovaný DocumentSet, název "batch1.zip"

Odešle

• identifikátor DocumentSetu

• zámek DocumentSetu

• jméno uživatele

Request
<?xml version="1.0?>
<ProcessedRequest id="" lockId="" user="" pause="0|1" differential="0|1"/>

Response
<?xml version="1.0?>
<ProcessedResponse status="OK|FAIL"/>

OK - DocumentSet byl oznacen jako zpracovany
FAIL - DocumentSet se nepodarilo oznacit jako zpracovany

Uvolnění spisu pro archivaci

Pokud byl spis uložen s atributem pause=1 je nutno ho samostatným příkazem uvolnit pro další zpracování. Požadavek je označen jako ResumeRequest

Request
<?xml version="1.0?>
<ResumeRequest id="" user=""/>

Response
<?xml version="1.0?>
<ResumeRequestResponse status="OK|FAIL"/>

OK - DocumentSet byl oznacen jako znovuvlozeny
FAIL - DocumentSet se nepodarilo oznacit jako znovuvložený

Oznámení o znovuvložení spisu do Damisu

Zde se odesílá multipart zpráva složená ze dvou částí

1. xml s níže popsaným příkazem, název "command"

2. zazipovaný DocumentSet, název "batch1.zip"

Odešle

• identifikátor DocumentSetu

• zámek DocumentSetu

• jméno uživatele

Request
<?xml version="1.0?>
<ReinsertRequest id="" lockId="" user=""/>

Response
<?xml version="1.0?>
<ReinsertResponse status="OK|FAIL"/>

OK - DocumentSet byl oznacen jako znovuvlozeny
FAIL - DocumentSet se nepodarilo oznacit jako znovuvložený

Poznámka: Slouží pro znovuvložení opravených spisů po reklamaci

Oznámení o odmítnutí spisu

Odešle

• identifikátor DocumentSetu

• zámek DocumentSetu

• jméno uživatele
• důvod odemčení dokumentu

Request
<?xml version="1.0?>
<UnlockRequest id="" lockId="" user="" reason=""/>

Response
<?xml version="1.0?>
<UnlockResponse status="OK|FAIL"/>

OK - DocumentSet byl odemknut
FAIL - DocumentSet se nepodarilo odemknout

Vyžádání DocumentSetu

Odešle

• identifikátor DocumentSetu

• zámek DocumentSetu

• jméno uživatele

Vrátí soubor se zazipovaným DocumentSetem

Request
<?xml?>
<DocumentSetRequest id="" lockId="" user=""/>

Response
zazipovany soubor (batch.zip) s DocumentSetem

Oznámení, že vyžádaný DocumentSet je stále používán

Odešle

• jméno uživatele

• seznam DocumentSetu, ktere ma zamcene ( u každého DocumentSetu posílá id, lockId)

Vrátí seznam DocumentSetu, pro ktere to opravdu plati (vrati podmnozinu toho co jsem odeslal)

Request - poslu seznam DocumentSetu, ktere mam zamknute
<?xml version="1.0?>
<NotifyRequest user="">
 <LockedDocumentSet id="" lockId=""/>
 <LockedDocumentSet id="" lockId=""/>
<NotifyRequest/>


Response - vrati seznam DocumentSetu, pro ktere to stale plati 
<?xml version="1.0?>
<NotifyResponse>
 <LockedDocumentSet id="" lockId=""/>
 <LockedDocumentSet id="" lockId=""/>
</NotifyResponse>

Příklad komunikace

Příklad HTTP komunikace (žádost):

POST /damis/DamisServlet HTTP/1.1
Host: 10.2.0.6:8080
Keep-Alive: 
Connection: TE, Keep-Alive
TE: trailers
Content-Type: text/xml
Content-Length: 57

<?xml version="1.0"?><LockRequest id="00000009" user=""/>

Příklad HTTP komunikace (odpověď):

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: text/xml
Transfer-Encoding: chunked
Date: Mon, 05 Sep 2005 10:25:28 GMT

<?xml version="1.0" encoding="UTF-8"?><LockResponse lockId="10625d1a505-78a145df-be5e9dd8" status="LOCKED"/>

Vložení dávky do Damisu

Příkaz vložení dávky do Damisu

Request

Odesílá se multipart zpráva složená ze dvou částí

1. xml s níže popsaným příkazem, název "command"
2. zazipovaná dávka, název "batch.zip", dávka je ve formátu pro vstup do Damisu bez příznakového souboru complete

Formát souboru command

<?xml version="1.0"?>
<BatchInsertRequest id="" user="franta" domain="" extendedCheck="1"/>

Response

Jako odpověď přijde xml soubor

<?xml version="1.0"?>
<BatchInsertResponse id="" status="OK|FAIL|COLLISION" error="">
  <BatchIdCollision/>
  <IdCollision id=""/>
  <Rule name=""/>
  <MimeType type=""/>
</BatchInsertResponse>

<BatchIdCollision> příznak kolize čísla dávky, vyskytne se v odpovědi maximálně jednou a pouze když je nastaven status=COLLISION

<IdCollision id=""/> příznak kolize čísla spisu, jeden výskyt pro každé kolidující id, pouze když je nastaven status=COLLISION

• id kolidující identifikátor

<Rule> příznak odmítnutí dávky vstupním pravidlem. Platné pouze pokud je nastaven status=FAIL. V atributu name je název pravidla.

<MimeType> odmítnutí dávky kvůli nepodporovanému mimetypu. Platné pouze pokud je nastaven status=FAIL. V atributu je název mimetypu.

Kontrola dávky před vložením do Damisu

Příkaz pro kontrolu dávky před vložením do Damisu

Request

Odesílá se multipart zpráva složená ze dvou částí

1. xml s níže popsaným příkazem, název "command"
2. soubor, který obsahuje všechny soubory docset.xml z dávky. Jedná se o soubor ve formátu shodném jako při odesílání celé dávky jen bez datových souborů

Formát souboru command

<?xml version="1.0"?>
<BatchCheckRequest user="franta" domain=""/>

Response

Jako odpověď přijde xml soubor

<?xml version="1.0"?>
<BatchCheckResponse status="OK|FAIL|STRUCTURAL_FAIL">
  <BatchIdCollision/>
  <IdCollision id=""/>
  <IdRule id="" name=""/>
</BatchCheckResponse>

<BatchIdCollision> příznak kolize čísla dávky, vyskytne se v odpovědi maximálně jednou a pouze když je nastaven status=STRUCTURAL_FAIL

<IdCollision id=""/> příznak kolize čísla spisu, jeden výskyt pro každé kolidující id, pouze když je nastaven status=STRUCTURAL_FAIL

• id kolidující identifikátor

<IDRule id="" name=""> příznak neplatnosti spisu na základě rozhodnutí vstupních pravidel, jeden výskyt pro každý spis, který neprojde pravidly, pouze když je nastaven status=STRUCTURAL_FAIL

• id číslo spisu, který neprošel pravidly
• name název pravidla, které spis nesplňuje

Získání seznamu spisů v UNLOCKED stavu pro konkrétního uživatele

Příkaz pro získání id všech spisů v UNLOCKED stavu konkrétního uživatele

Request

<?xml version="1.0"?>
<DocumentSetsForUserRequest user=""/>

Response

Jako odpověď přijde seznam id spisů

<?xml version="1.0"?>
<DocumentSetsForUserResponse>
  <DocumentSet id=""/>
  <DocumentSet id=""/>
</DocumentSetsForUserResponse>

Alokace hodnot identifikátorů

Příkaz pro získání hodnot identifikátorů z číselné řady

Request

<?xml version="1.0"?>
<AllocAttributesRequest user="" domain="" numAttributes=""/>

Response

Jako odpověď přijde seznam hodnot atributů

<?xml version="1.0"?>
<AllocAttributesResponse status="OK|FAIL">
  <Attribute value=""/>
  <Attribute value=""/>
</AllocAttributesResponse>

Zahájení přenosu dávky

Příkaz pro zahájení přenosu dávky

Request

<?xml version="1.0"?>
<StartSendingRequest user="" domain="" size="" id="" extendedCheck="1"/>

Response

<?xml version="1.0"?>
<StartSendingResponse status="OK|FAIL" handle=""/>

Přenos bloku dat dávky

Příkaz pro přenos bloku dat dávky. Odesílá se multipart zpráva složená ze dvou částí

1. xml s níže popsaným příkazem, název "command"
2. blok dat zazipované dávky, název "batch.part"

Request

<?xml version="1.0"?>
<SendDataBlockRequest handle="" from="" size=""/>

Response

<?xml version="1.0"?>
<SendDataBlockResponse status="COLLISION|COMPLETE|PARTIAL|FAIL|BADPOSITION" id="">
  <BatchIdCollision/>
  <IdCollision id=""/>
</SendDataBlockResponse>

Zjištění stavu přenosu (velikost již odeslaných dat)

Request

<?xml version="1.0"?>
<SendStatusRequest handle=""/>

Response

<?xml version="1.0"?>
<SendStatusResponse status="COMPLETE|PARTIAL|UNKNOWN|COLLISION" from=""/>

Vymazání dokumentu

Request

<?xml version="1.0"?>
<DeleteRequest id="" lockId="" user=""/>

Response

<?xml version="1.0"?>
<DeleteResponse status="OK|FAIL"/>