Lokálne dokumenty

Toto API poskytuje dokumenty z registratúry. Dokumenty poskytuje v podobe URL adresy, z ktorej si možno daný dokument stiahnuť. Toto umožňuje ďalším aplikáciám pristupovať k dokumentom, ktoré sú uložené v programe Optivus v registratúre. Prístup k dokumentom je vždy v dvoch krokoch.

• Získanie URL dokumentu v Optivuse
• Používanie uloženej URL v inej aplikácií

Získanie URL dokumentu v Optivuse

Dokument sa do registratúry vloží obvyklým spôsobom. Akonáhle je v registratúre, možno k nemu získať aj prístup cez URL. Tú získame nasledovne:

• Prepnite sa na záložku Registratúra.
• Vyhľadajte daný dokument a označte ho v zozname.
• Potom použite funkciu menu API/Skopírovať cestu k dokumentu cez API.
• URL adresa bude skopírovaná v schránke a môžete ju vložiť do svojej aplikácie.

Používanie uloženej URL v inej aplikácií

URL adresa má nasledovnú podobu (v ukážke sú URL pre dva rôzne dokumenty). Je to URL adresa na HTTP server v lokálnej sieti, ktorá poskytuje prístup k dokumentom.

http://localhost:3001/interface/test/urldocinternal/v1/document?id=MTMtMjU=
http://localhost:3001/interface/test/urldocinternal/v1/document?id=MjAtMzI=

Túto adresu si musíte vložiť vo vašej aplikácie. Predpokladajme nasledovný scenár. Pracujete vo firme, kde si dokumenty skladujete v registratúre a k niektorým dokumentom máte aj záznamy v inej aplikácií. Dodávateľ tejto aplikácie vám ju upravil tak, že v nej máte pole pre URL adresu vzdialeného dokumentu. Máte v nej aj tlačidlo (alebo položku v menu), ktorým sa bude dokument zobrazovať.

Vkladanie adresy dokumentu

Vyhľadajte si záznam v zozname a otvorte dialóg na jeho editáciu. Nájdite pole pre URL dokumentu. Do tohoto poľa musíte vložiť zo schránky adresu, ktorá tam bola skopírovaná v predchádzajúcom kroku. Potom dialóg potvrďte.

Pristupovanie k dokumentu

Vyhľadajte si záznam v zozname a použite funkciu na jeho zobrazenie.

Nastavenie programu Optivus

Toto nastavenie vám urobia naši zamestnanci pri inštalácii API. Adresa v lokálnej sieti sa nastavuje v položke Globálne nastavenie/Optivus Cloud/URL pre API.

Používanie rozhrania v inej aplikácií

Toto sú pokyny pre programátorov, ktorí budú implementovať volanie API. Pre záznamy vo svojej aplikácii potrebujete doplniť jedno textové pole pre URL adresu dokumentu. Stiahnutie dokumentu je identické, ako keby ste ho sťahovali z ľubovoľnej adresy na Internete. Na druhej strane je implementované podobne, ako je to v nasledovnom ukážkovom príklade. Príklad je len ilustračný, aby ste mohli pochopiť, ako sa dokument zo servera odosiela.

router.get('/:db/urldocinternal/v1/document', function (req, res, next) {
  let id = req.query.id;
  let buff = new Buffer(id, 'base64');
  let did = buff.toString('ascii');

  let config = {
    db: req.params.db,
  };
  let db = new DatabaseBuilder(config);
  db.call(req, res, async function(db) {
    let parameter = parseInt(did) || 0;
    let qdoc = await db.queryInt('select * from xxx where ds_id=@id', parameter);
    db.connection.close();
    if (qdoc.length) {
      var img = qdoc[0].filedata;
      res.writeHead(200, {
        'Content-Type': mime.lookup(qdoc[0].popis),
        'Content-Length': img.length,
        'Content-Disposition': 'inline; filename="' + qdoc[0].popis + '"'
      });
      res.end(img);
    }
    else
      res.status(400).json({error: 'Item not found.'});
  });
});

V programe by ste mali doplniť aj možnosť na stiahnutie dokumentu. Je v podstate jedno, ako sa rozhodnete. Môže to byť implementované ako:

• Položka v menu na stiahnutie dokumentu
• Tlačidlo na dialógu na stiahnutie dokumentu.

Ako stiahnuť k sebe samotný dokument

Dôležité je skontrolovať, či sa v URL nachádza podreťazec urldocinternal/v1/document. Ak sa tam nachádza, tak len celú URL použijete na stiahnutie dokumentu.

Ak sa tam nenachádza, potom je potrebné považovať danú URL alebo za chybnú, alebo za novšiu implentáciu API dokumentov a užívateľovi je treba zobraziť nasledovné chybové hlásenie.

Tento dokument bol vložený chybne, alebo je daná adresa dokumentu určená pre novšie verzie API, ktoré náš program momentálne nepodporuje.

Ak vráti API chybu 400

Toto môže signalizovať dva stavy.

• Alebo užívateľ omylom zmenil originálnu adresu, ktorú mal skopírovanú v schránke. Užívatelia môžu byť nepozorní, alebo majú rýchle prsty.
• Alebo bol dokument v čase vloženia validný, ale v priebehu času došlo napríklad k jeho vymazaniu. To sa môže stať napríklad vtedy, ak prešiel cez vyraďovacie konanie a už bol skartovaný.

Vtedy treba zobraziť nasledovné chybové hlásenie.

Tento dokument bol vložený chybne, alebo je daná adresa dokumentu už neprístupná a