Handleiding. Versie Laatste wijziging: Ontwikkeld door iadvise. w: m:

Handleiding

Versie 01.01 Laatste wijziging: 17-05-2013 Ontwikkeld door iAdvise

w: http://www.docufy.be m: [email protected] t: @docufy

iAdvise

Docufy

I NHOUDSTABEL 1

2

3

4

5

Inleiding................................................................................................................................. 4 1.1

Woord vooraf ................................................................................................................. 4

1.2

Wat mag je verwachten van Docufy? ............................................................................. 5

1.3

Wat is reeds mogelijk in Docufy? .................................................................................... 5

Installatie .............................................................................................................................. 6 2.1

Software vereisten ......................................................................................................... 6

2.2

Installatie........................................................................................................................ 6

Op verkenning in Docufy ....................................................................................................... 8 3.1

Folders ............................................................................................................................ 9

3.2

Documenten .................................................................................................................. 11

Een eerste rapport................................................................................................................ 13 4.1

Folder en document aanmaken (Start) .......................................................................... 13

4.2

Gegevens selecteren (Wat?) .......................................................................................... 15

4.3

Templates maken (Hoe?) ............................................................................................... 19

4.4

Preview opvragen (Preview) ..........................................................................................24

4.5

Rapport oproepen (Run) ................................................................................................26

Uitgewerkt voorbeeld ..........................................................................................................29 5.1

Situering ........................................................................................................................29

5.2

Uitwerking ..................................................................................................................... 31

5.2.1 Folder en document aanmaken (Start) ................................................................................. 31 5.2.2 Gegevens selecteren (Wat?) .................................................................................................... 31 5.2.2.1 Orders ......................................................................................................................... 31 5.2.2.2 Customers .................................................................................................................. 34 5.2.2.3 Items (List) ................................................................................................................. 36 5.2.2.4 Items (table) .............................................................................................................. 37 5.2.2.5 Product available...................................................................................................... 39 Inhoudstabel Docufy - Handleiding Versie: 01.01

2 - 60

iAdvise

Docufy

5.2.3 Template aanmaken (Hoe?) ..................................................................................................... 40 5.2.3.1 De brief ....................................................................................................................... 41 5.2.3.2 De bijlage ................................................................................................................... 43 6

Tips & tricks ..........................................................................................................................45

7

Deployment..........................................................................................................................47

8

7.1

Exporteren van een document ......................................................................................47

7.2

Importeren van een document ......................................................................................47

Admin mogelijkheden ..........................................................................................................49 8.1

Userbeheer ....................................................................................................................49

8.2

Logging .......................................................................................................................... 51

8.2.1 8.2.2 8.3 9

Log configurations ...................................................................................................................... 51 Log messages ............................................................................................................................... 52

Beheren van licenties ....................................................................................................53

Over iAdvise .........................................................................................................................54 9.1

Oracle en Java oplossingen ............................................................................................54

9.2

Contact informatie ........................................................................................................54

APPENDIX Installatie ..................................................................................................................55 Inleiding ...................................................................................................................................55 Installatiestappen binnen APEX ...............................................................................................55

Inhoudstabel Docufy - Handleiding Versie: 01.01

3 - 60

iAdvise

Docufy

1 INLEIDING 1.1 W OORD VOORAF Op dit moment bestaan er nauwelijks (goedkope) producten voor het genereren van Microsoft Worddocumenten op basis van gegevens uit de Oracle databank. Tools die hiervoor toch in aanmerking zouden kunnen komen, zijn vaak duur, vereisen een ingewikkelde installatieprocedure of zijn moeilijk in gebruik. Dankzij de Docufy tool, een oplossing geschreven in puur PL/SQL, is het vanaf nu wel mogelijk om met een laag budget en op een eenvoudige manier documenten te genereren vanuit de Oracle databank. Brondocumenten (templates) kunnen door de gebruiker opgemaakt en opgeladen worden en hieruit kunnen op een eenvoudige en snelle manier Word-documenten gegenereerd worden waarin gegevens vanuit de Oracle databank worden samengevoegd. De front-end voor het beheren van je metadata, zoals het selecteren van je data of het opladen van de templates, is gemaakt in Oracle Application Express (APEX). Het is een eenvoudige tool waarmee je, zonder een omslachtige installatieprocedure, onmiddellijk aan de slag kunt. Bovendien zijn er toch al heel wat reporting functionaliteiten in opgenomen. Uitbreidingen, zoals het genereren naar andere formaten (PDF, XLSX …) staan nog op het programma. We wensen je alvast veel plezier met Docufy!

Inleiding Docufy - Handleiding Versie: 01.01

4 - 60

iAdvise

Docufy

1.2 W AT MAG JE VERWACHTEN VAN D OCUFY ? -

-

Eenvoudige tool waarmee je heel snel aan de slag kunt gaan Volledig gebruik van alle Microsoft Word opties, zoals verschillende lettertypes, vet, onderstrepen, lijsten, tabellen, afbeeldingen, … Scheiding van templates en data. Templates kunnen eventueel aangeleverd worden door de gebruiker, zonder dat deze over Oracle-kennis hoeft te beschikken. De data kan los hiervan worden samengesteld door een Oracle-ontwikkelaar De layout van de documenten wordt bepaald door de opmaak van de template in Microsoft Word. De gebruiker heeft dus enkel kennis van deze tekstverwerker nodig Microsoft Word tabellen worden ondersteund en kunnen worden gevuld met gegevens uit de Oracle databank Opsommingslijsten, zowel de ongenummerde als de genummerde, worden ondersteund en kunnen worden gevuld met gegevens uit de Oracle-databank Dynamische kop-en voetteksten worden ondersteund Afbeeldingen en grafieken in de template worden ondersteund …

1.3 W AT IS REEDS MOGELIJK IN D OCUFY ? -

Input van gegevens uit de Oracle-databank via SQL-statements Vastleggen van input parameters Hergebruik van kolommen en parameters in andere SQL-statements Geneste master-detail structuren Gegevens weergeven volgens verschillende layout mogelijkheden: tekst (paragrafen), tabellen en lijsten Conditioneel weergeven van teksten en gegevens Conditionele opmaak van teksten en gegevens Weergeven van afbeeldingen: zowel vast in de template als afbeeldingen uit de databank Opladen van verschillende templates (o.a. nuttig indien je je rapport naar verschillende talen wil genereren) Genereren naar DOCX

Inleiding Docufy - Handleiding Versie: 01.01

5 - 60

iAdvise

Docufy

2 INSTALLATIE 2.1 S OFTWARE VEREISTEN Databank APEX

Oracle 10.2 of hoger APEX 4.x of hoger

2.2 I NSTALLATIE Docufy 01.01 komt als een export bestand van een Packaged Application voor APEX. Dit bestand bevat dus 1) zowel de APEX UI 2) als alle database objecten als “supporting objects”. Het installatieproces bestaat uit de volgende stappen 1. Maak een specifiek Docufy database schema aan 2. Maak een workspace in APEX aan en koppel hieronder het Docufy database schema 3. Meld aan op deze workspace en importeer hierin de toegezonden APEX export file, inclusief de “Supporting Objects”. Meer informatie betreffende de derde stap kan u vinden in de Appendix.

OPMERKINGEN 

Standaard verwijst de IMAGE_PREFIX eigenschap naar /i/. Gelieve deze aan te passen indien nodig naar jouw omgeving.



De installatie van Docufy komt met één standaard gebruiker: admin / admin. Gelieve dit paswoord aan te passen via de applicatie naar de eigen specifieke vereisten.



De “Supporting Objects”, waarvan sprake is in stap 3 van de installatie, bevatten alle nodige Docufy objecten + de PL/SQL engine.

Installatie Docufy - Handleiding Versie: 01.01

6 - 60

iAdvise

Docufy

Voorbeeld script voor het aanmaken van een specifiek Docufy schema REM change password + tablespace name to your requirements create user dg4o_0101 identified by <my_password> default tablespace users temporary tablespace temp quota unlimited on users; GRANT GRANT GRANT GRANT GRANT GRANT GRANT GRANT GRANT GRANT GRANT GRANT

CREATE SESSION TO dg4o_0101; CREATE SEQUENCE TO dg4o_0101; CREATE SYNONYM TO dg4o_0101; CREATE PUBLIC SYNONYM TO dg4o_0101; CREATE ANY CONTEXT TO dg4o_0101; CREATE PROCEDURE TO dg4o_0101; DROP PUBLIC SYNONYM TO dg4o_0101; CREATE TYPE TO dg4o_0101; CREATE ANY DIRECTORY TO dg4o_0101; CREATE TRIGGER TO dg4o_0101; CREATE VIEW TO dg4o_0101; CREATE TABLE TO dg4o_0101;

Installatie Docufy - Handleiding Versie: 01.01

7 - 60

iAdvise

Docufy

3 OP VERKENNING IN D OCUFY Om op verkenning te gaan in Docufy, moet Docufy eerst opgestart worden in een internetbrowser. Surf naar de juiste APEX url en meld je aan met je gebruikersnaam en wachtwoord.

Na succesvol aanmelden, kom je op de “Home”-pagina terecht. Afhankelijk van de rechten die je gebruiker toegekend heeft gekregen en de folders waartoe je toegang hebt, krijg je onderstaand scherm te zien.

Je kan steeds terugkeren naar deze startpagina via de broodkruimelnavigatie bovenaan, net onder de zwarte balk of door op het Docufy logo te klikken in de linker bovenhoek.

Op verkenning in Docufy Docufy - Handleiding Versie: 01.01

8 - 60

iAdvise

Docufy

3.1 F OLDERS Links wordt via een handige interactieve boomstructuur een overzicht getoond van al de folders, subfolders, documenten en document details waartoe je toegang hebt. Rechts worden de details getoond van het aangeklikte tree-item. Op de volgende afbeelding zie je een overzicht van je folders.

Folders aanmaken kan je doen via de knop “Create Folder”. Kies een goede naam, vul eventueel wat uitleg in en kies indien nodig een bovenliggende folder waaronder deze nieuwe folder zal vallen. Klik vervolgens op “Create”.


9 - 60

iAdvise

Docufy

Een folder openen, doe je door op de gewenste folder te klikken in de boomstructuur links. Op de onderstaande afbeelding zie je dat de folder “DOCUFY” geopend is. Deze folder bevat op zijn beurt twee subfolders, nl. “DEMO” en “SYSTEM”. Onder de folder “DEMO” is o.a. het demorapport “Order Confirmation” aangemaakt, die we verder in deze handleiding zullen bespreken.

Je kan de eigenschappen van je folder bekijken en bewerken (aanpassen, importeren, verwijderen) via de knop “Actions”.


10 - 60

iAdvise

Docufy

3.2 D OCUMENTEN Documenten kunnen op alle folderniveaus aangemaakt worden. Indien je in de boomstructuur op een folder met documenten klikt, krijg je rechts de details van deze documenten te zien. Via de broodkruimelnavigatie kan je altijd terug uit je folders navigeren.

Documenten aanmaken kan je doen via de knop “Create Document” of via het “+”-icoontje dat verschijnt als je over een folder in de boomstructuur hoovert. Kies een geschikte naam voor je document, vul eventueel wat uitleg in en kies de juiste folder waartoe dit nieuwe document zal behoren. Klik vervolgens op “Create”.

Merk op dat de begin- en eindtag kunnen ingesteld worden per document. In dit geval zijn dit vierkante haken “*” en “+”, maar deze kunnen indien gewenst aangepast worden. We zullen deze tags nodig hebben tijdens het aanmaken van de templates. Op verkenning in Docufy Docufy - Handleiding Versie: 01.01

11 - 60

iAdvise

Docufy

Een document openen, doe je door op het gewenste document te klikken in de boomstructuur links. Op de onderstaande afbeelding zie je dat het document “Order Confirmation” geopend is. Een document bestaat uit één of meerdere SQL statements, één of meerdere templates en eventueel input parameters. Op de onderstaande afbeelding is het demorapport “Order Confirmation” geopend. Zowel in de boomstructuur links, als in het detailoverzicht rechts kan je gemakkelijk navigeren tussen de SQL statements, de templates en de parameters.

Je kan de eigenschappen van je document bekijken en bewerken (aanpassen, verwijderen, verplaatsen, exporteren, …) via de knop “Actions”. Een preview (DOCX-rapport) opvragen van je werk, doe je via de knop “Preview” of via het handige oog-icoontje dat verschijnt als je over een document in de boomstructuur hoovert.


12 - 60

iAdvise

Docufy

4 E EN EERSTE RAPPORT Bij het aanmaken van een rapport doorloop je steeds enkele stappen. Eventueel worden deze meerdere keren achter elkaar herhaald, totdat je het gewenste resultaat bekomen hebt.

4

Stap Start Data = Wat? Layout = Hoe? Preview

5

Run

1 2 3

Omschrijving Aanmaken van gewenste folder en document Selecteren van de databank gegevens die je in je rapport wil weergeven Vastleggen op welke manier je de gegevens wil tonen in je rapport via een template Preview opvragen van je rapport om te zien of het aan je wensen voldoet Oproepen van je rapport vanuit je eigen toepassing

Waar? In de Docufy tool In de Docufy tool In een eigen Wordtemplate In de Docufy tool In je eigen toepassing

In de volgende paragrafen wordt beknopt omschreven hoe je deze verschillende stappen kan uitvoeren met de Docufy tool.

4.1

F OLDER EN DOCUMENT AANMAKEN (S TART )

Voordat je begint, creëer je best een geschikte folder voor je test-rapporten of navigeer je naar de gewenste folder. Voor deze handleiding gebruiken we de folder “MY_DOCUMENTS”.

Een eerste rapport Docufy - Handleiding Versie: 01.01

13 - 60

iAdvise

Docufy

Deze folder is aanvankelijk leeg.

Creëer vervolgens het gewenste document waaronder je alle metadata, zoals SELECT-statements, templates en parameters, voor je rapport zal beheren. Klik hiervoor rechtsboven op de knop “Create Document” of klik op het “+”-icoontje dat verschijnt als je over de folder hoovert waaronder je het document wenst aan te maken.

Kies een gepaste naam voor je document en vul eventueel een beknopte beschrijving in. Klik vervolgens rechtsonder op de knop “Create”.


14 - 60

iAdvise

Docufy

Nadat het document is aangemaakt, zien we deze onder de folder verschijnen waar deze is aangemaakt. Als we nu op de documentnaam klikken, kunnen we dit document echt vorm gaan geven door “SQL Statements” toe te voegen, “Templates” op te laden en eventuele input “Parameters” te definiëren. Merk op dat je verschillende mogelijkheden hebt om tussen de verschillende gegevens te navigeren: dit kan zowel via de boomstructuur links, als via de de tabs in het detailscherm rechts.

4.2

G EGEVENS SELECTEREN (W AT ?)

In deze stap bepaal je welke gegevens je wil tonen in je rapport. Dit doe je door de gegevens te selecteren via één of meerdere SELECT-statements.

Eerst en vooral hebben we gegevens nodig om in ons rapport weer te geven. In dit voorbeeld zullen we een eenvoudig overzichtje tonen van alle geplaatste bestellingen uit de tabel DEMO_ORDERS. Klik op de knop “Create SQL” in de “SQL”-tab en vul de velden in.


15 - 60

iAdvise

Docufy

Name Kies een duidelijke, unieke naam voor je SQL-statement. Description Optioneel kan er een beschrijving toegevoegd worden. Parent SQL statement In het geval je een master-detail structuur wil weergeven, kan je hier je master SQL-statement aanduiden. De keuzelijst wordt automatisch gevuld met alle reeds aangemaakte SQL-statements. SQL Statement Hierin schrijf je je statement dat de gewenste gegevens ophaalt uit de databank om later in je rapport te tonen.


16 - 60

iAdvise

Docufy

Usage in Document Via dit keuzelijstje maak je duidelijk op welke manier je de gegevens zal weergeven in je rapport. Je hebt hierbij keuze uit vijf soorten layouts: -

Table: in een tabel List: in een genummerde of ongenummerde opsommingslijst Global document: in een paragraaf, als gewone losstaande tekst Page Break: in een paragraaf, waarbij na elk record van het SELECT statement steeds een page break wordt toegevoegd - Page Reset: in een paragraaf, waarbij na elk record van het SELECT statement steeds een page break wordt toegevoegd en eventuele pagina nummers terug worden gereset naar 1 Recordset Code Kies een duidelijke, unieke code voor je SQL-statement. Deze code zal je in je template moeten gebruiken om naar je statement te verwijzen. Tip: gebruik hiervoor hoofdletters, zo vallen ze op in je document tussen de gewone teksten. Document Area Via dit keuzelijstje kan je aanduiden in welke area in je rapport je de gegevens zal willen plaatsen. Je hebt hierbij keuze uit drie mogelijkheden: - Body of a document - Header of a document - Footer of a document Parse SQL Het is steeds mogelijk om na het ingeven van een SQL-statement de syntax te controleren door te klikken op de knop “Parse SQL”. Afhankelijk van of dit geslaagd is, wordt een gepaste mededeling zichtbaar.


17 - 60

iAdvise

Docufy

Copy from SQL SQL-statements kunnen gekopieerd worden vanuit alle documenten uit alle folders waartoe je toegang hebt.

Klik tenstlotte op de knop “Create” om het aanmaken van je SQL-statement te bevestigen. Als je nu terug gaat naar de informatiepagina betreffende het aangemaakte document, zien we dit SQLstatement staan in het tabblad “SQL”.

Heb je nog meer gegevens nodig, dan kan je deze selecteren via extra SQL-statements. Je kan deze “Create SQL” stap zo vaak als je wil herhalen, totdat je alle gegevens verzameld hebt. Voor het wijzigen van een reeds geschreven SQL-statement, klik je op de naam van dit statement. In de volgende stap zullen we een template maken en deze hier opladen.


18 - 60

iAdvise

4.3

Docufy

T EMPLATES MAKEN (H OE ?)

In deze stap leg je de layout van je rapport vast. Je bepaalt hoe je rapport er precies moet uitzien en dit kan je heel eenvoudig door je rapport uit te ‘tekenen’ in een Word-document (=template). In deze Word-template mag je alle functionaliteiten gebruiken die Microsoft Word je aanbiedt. Op plaatsen waar je gegevens uit de databank wil inlassen zet je een “code”-woord. Deze code-woorden, kortweg codes, mag je op verschillende plaatsen gebruiken: 1. In een paragraaf als gewone tekst 2. In een opsommingslijst 3. In een tabel De codes kunnen gebruikt worden voor verschillende doeleinden. Hiervoor is telkens een bepaalde syntax te volgen: 1. Starten van een set gegevens afkomstig uit een SQL-statement: [BEGIN:MY_RECORDSET_CODE] 2. Afsluiten van een set gegevens afkomstig uit een SQL-statement: [END:MY_RECORDSET_CODE] 3. Ophalen van gegevens uit een SQL-statement: [MY_COLUMN_NAME] 4. Conditioneel weergeven van gegevens: [IF:MY_CHECK+ … inhoud indien MY_CHECK = 1 … [ELSE:MY_CHECK+ … inhoud indien MY_CHECK = 0 … (niet verplicht te noteren, indien leeg) [ENDIF:MY_CHECK] Hierbij is MY_CHECK een kolom uit een SQL-statement die 1 of 0 teruggeeft 5. Weergeven van afbeeldingen uit de databank [MY_BLOB_COLUMN] Hierbij is MY_BLOB_COLUMN een kolom uit een SQL-statement die een BLOB teruggeeft Het teken voor de begin- en eindtag kunnen bij de Document Info ingevuld worden en staan standaard ingesteld op linker en rechter vierkante haakjes.


19 - 60

iAdvise

Docufy

Als je in een volgende stap je rapport gaat genereren, zal je rapport er op precies dezelfde manier uitzien, zoals je dat bepaald hebt in je Word-template. De codes zijn hierbij vervangen door de gewenste gegevens uit je SELECT-statements. Heb je de codes in een tabel geplaatst dan zal Docufy automatisch het juiste aantal rijen tonen volgens het aantal records dat het bijhorende SELECT-statement teruggeeft. Staat er een code in een opsommingslijst, dan zal deze lijst eveneens het juiste aantal items bevatten volgens het bijhorende SELECT-statement. Deze paragraaf legt uit hoe je je template maakt. Meer gedetailleerde informatie over het conditioneel weergeven van gegevens en het tonen van afbeeldingen in je rapport, vind je in het uitgewerkte voorbeeld in het volgende hoofdstuk. Om je template te maken, open je Microsoft Word. Maak je document op zoals je wil dat je rapport er zal moeten uitzien: titels, tabellen, lijsten, kop- en voetteksten, afbeeldingen, … Wil je gegevens uit een SQL-statement inlassen, dan heb je drie weergave-mogelijkheden: paragraaf, opsommingslijst of tabel. Enkele concrete voorbeelden: Paragraaf [BEGIN:ORDERS]Customer [CUST_NAME] made an order on [ORDER_DATE]. He had to pay €*ORDER_TOTAL+ for the ordered products.[END:ORDERS] Opsommingslijst  [BEGIN:ORDERS][CUST_NAME] - [ORDER_DATE] - €*ORDER_TOTAL+*END:ORDERS] Tabel Customer Name [BEGIN:ORDERS] [CUST_NAME]

Order Date [ORDER_DATE]

Order Total (€) [ORDER_TOTAL] [END:ORDERS]


20 - 60

iAdvise

Docufy

BELANGRIJKE OPMERKINGEN 1. Het is steeds verplicht om het begin en het einde van een statement aan te duiden via de BEGIN- en END-tags, ongeacht de weergave. 2. De gebruikte codes in de BEGIN- en END-tags verwijzen naar de Recordset Codes uit de SQLstatements. Voor een betere leesbaarheid, wordt aangeraden om deze codes steeds in hoofdletters te noteren, bv. [BEGIN:ORDERS]. 3. De gebruikte codes voor het verwijzen naar de kolomnamen in de SQL-statements, kunnen eveneens best in hoofdletters worden genoteerd, bv. [CUST_NAME], [ORDER_DATE] en [ORDER_TOTAL]. Een voorbeeld van een mogelijke template in Word:

Sla je template op en geef het hierbij een betekenisvolle naam, bv. orders_template.docx. Ga vervolgens terug naar je document in de Docufy-webtoepassing. Navigeer naar de juiste folder en selecteer het document waarvoor je een template wilt toevoegen (dezelfde als waar je daarnet een SQLstatement hebt voor geschreven).


21 - 60

iAdvise

Docufy

Onder de tab “Templates” kan je je templates opladen. Op dit moment is het lijstje van opgeladen templates nog leeg.

Klik op de knop “Create Template” van het tabblad “Templates” of klik op het “+”-icoontje dat verschijnt als je in de opengeklikte boomstructuur over “Templates” hoovert, om de gemaakte template toe te voegen. Vul de velden in.


22 - 60

iAdvise

Docufy

Template Name Kies een duidelijke, unieke naam voor je document template. Upload New Template Kies hier het eerder opgeslagen Word-document die als template gaat dienen. De naam hiervan wordt ook de filename. Template Format Bestandstype van de template. Op dit moment kan je enkel DOCX aanduiden. Later zal het ook mogelijk worden om je templates bv. in Microsoft Excel (XLSX) aan te maken. Description Hierin kan je informatie invullen betreffende je template. Klik op de knop “Create” om het aanmaken van je document template te bevestigen. Je ziet nu dat je template is opgeladen.

Je kan meerdere templates opladen voor een document. Bij het genereren van je rapport kies je dan volgens welke template de report generator je gegevens moet weergeven. Dit kan handig zijn indien je bv. een nederlandstalige en een franstalige versie van eenzelfde rapport wil maken. In dat geval maak je twee templates: ééntje in het Nederlands en ééntje in het Frans. Om meerdere templates toe te voegen, gelieve bovenstaande stap te herhalen. Wil je een bestaande template bekijken of de template aanpassen, klik dan op de naam van de template. Het is dan mogelijk deze aangepaste versie opnieuw te uploaden.


23 - 60

iAdvise

4.4

Docufy

P REVIEW OPVRAGEN (P REVIEW )

Nadat je de gewenste data hebt geselecteerd en je templates opgeladen zijn in de Docufy tool, kan je je rapport testen door een preview op te vragen. Ga in Docufy naar het overzicht van je aangemaakte documenten. Selecteer het juiste document en klik vervolgens op de “Preview”-knop in de rechterbovenhoek om het rapport te genereren.

Ook handig is de mogelijkheid om een preview op te vragen via de het “oog”-icoontje dat verschijnt als je over het gewenste document in de boomstructuur hoovert.

In beide gevallen kom je op het “Generate Preview” scherm terecht. Na selectie van de juiste template kan het rapport gedownload worden. Hier kies je op basis van welke template Docufy je rapport moet genereren. Het keuzelijstje wordt automatisch gevuld met al je opgeladen templates. Indien je gebruik hebt gemaakt van parameters, dan kan je de waarden eveneens hier invullen. Parameters worden in het uitgewerkte voorbeeld in het volgende hoofdstuk behandeld.


24 - 60

iAdvise

Docufy

Klik vervolgens op de knop “Download Preview”. Als alles succesvol verloopt, wordt er een rapport gegenereerd dat je kan opslaan en openen.

Het resultaat kan je bekijken door de gedownloade preview te openen.

Je kan voor een bepaald document de stappen 2 tot en met 4 zo vaak herhalen als je wil, totdat je rapport het gewenste resultaat heeft.


25 - 60

iAdvise

Docufy

4.5

R APPORT OPROEPEN (R UN )

Wanneer je klaar bent met je rapport in Docufy, zal je deze willen oproepen vanuit je eigen toepassing. Hiervoor is er een aanroepfunctie voorzien. Via een aantal parameters geef je de nodige gegevens en input parameters door. Als resultaat krijg je je gegenereerde document in de vorm van een BLOB. De aanroepfunctie bestaat onder een basis (eenvoudigere, maar beperktere) en een generieke (iets meer ingewikkelde, maar complete) vorm. Beide zijn terug te vinden in de package BL$DG4O_INTERFACE onder het database schema waarin Docufy werd geïnstalleerd.

Beperkte vorm FUNCTION generate_document( p_document IN VARCHAR2 ,p_document_template_name IN VARCHAR2 ,p_bind_variable_name_1 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_text_1 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_name_2 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_text_2 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_name_3 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_number_3 IN NUMBER DEFAULT NULL ,p_bind_variable_name_4 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_number_4 IN NUMBER DEFAULT NULL ,p_bind_variable_name_5 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_date_5 IN DATE DEFAULT NULL ,p_bind_variable_name_6 IN VARCHAR2 DEFAULT NULL ,p_bind_variable_date_6 IN DATE DEFAULT NULL ,p_application_key IN VARCHAR2 DEFAULT NULL ,p_user_id IN VARCHAR2 DEFAULT NULL) RETURN BLOB;

De parameters vul je als volgt op: 



Via de parameter “p_document” geef je je gewenste document mee. Zowel de naam van het document als het volledige pad moeten opgegeven worden en zijn hoofdlettergevoelig. Voor ons voorbeeldrapport wordt dit: p_document => ‘/MY_FOLDER/MY_DOCUMENTS/Order overview’ Via de parameter “p_document_template_name” geef je je gewenste template mee. Voor ons voorbeeldrapport wordt dit: p_document_template_name => ‘Orders template’


26 - 60

iAdvise





Docufy

Vervolgens heb je mogelijkheid om twee parameters in te vullen van datatype VARCHAR2, twee parameters van datatype NUMBER en twee parameters van datatype DATE. Dit kan een beperking opleveren, indien je rapport meerdere parameters vereist. In dat geval maak je gebruik van de generieke aanroepfunctie (zie verder). Voor ons voorbeeldrapport wordt dit: p_bind_variable_name_3 => 'P_ORDER_ID', p_bind_variable_number_3 => 1 (voor order id 1) Via de parameter “p_application_key” geef je de application key mee, indien deze voor het document vereist is. Meer informatie over application keys vind je onder het hoofdstuk “Admin mogelijkheden”. Voor ons voorbeeldrapport is geen application key vereist.

Generieke vorm FUNCTION generate_document (p_document IN VARCHAR2 ,p_document_template_name IN VARCHAR2 ,p_bind_variables IN bind_variables_t ,p_application_key IN VARCHAR2 DEFAULT NULL ,p_user_id IN VARCHAR2 DEFAULT NULL) RETURN BLOB

De parameters vul je als volgt op: 

 



Via de parameter “p_document” geef je je gewenste document mee. Zowel de naam van het document als het volledige pad moeten opgegeven worden en zijn hoofdlettergevoelig. Voor ons voorbeeldrapport wordt dit: p_document => ‘/MY_FOLDER/MY_DOCUMENTS/Order overview’ Via de parameter “p_document_template_name” geef je je gewenste template mee. Voor ons voorbeeldrapport wordt dit: p_document_template_name => ‘Orders template’ Vervolgens heb je i.p.v. een reeks van parameters slecht één record type parameter waarmee je alle input gegevens kan doorgeven. Voor ons voorbeeldrapport wordt dit: p_bind_variables => t_bind_variables Waarbij je t_bind_variables vooraf dient in te vullen: t_bind_variables('P_ORDER_ID').number_value := 1; (voor order id 1) Via de parameter “p_application_key” geef je de application key mee, indien deze voor het document vereist is. Meer informatie over application keys vind je onder het hoofdstuk “Admin mogelijkheden”. Voor ons voorbeeldrapport is geen application key vereist.


27 - 60

iAdvise

Docufy

Voorbeeld Om de functies te kunnen gebruiken in je eigen applicatie heb je een GRANT nodig op de package waartoe deze aanroepfuncties behoren, nl. de package BL$DG4O_INTERFACE. Een nuttige tip is ook een (al dan niet publiek) synoniem hiervoor aan te maken, bv. BL$DG4O_INTERFACE. Het genereren van je document kan je vervolgens laten gebeuren door onderstaande procedure in je toepassing uit te voeren (deze maakt gebruik van de generieke vorm van de aanroepfunctie). DECLARE t_bind_variables BL$DG4O_INTERFACE.bind_variables_t; l_doc BLOB; BEGIN t_bind_variables('P_ORDER_ID').number_value := 1; l_doc := BL$DG4O_INTERFACE.generate_document (p_document => '/Infokiosk/Rapport' ,p_document_template_name => 'Infokiosk_nl' ,p_bind_variables => t_bind_variables); … END;

Deze procedure levert een BLOB op, waarin je gegenereerde DOCX-document zit. Hiermee kan je verder in de toepassing aan de slag (downloaden, preview, printen, …).

Tip Via het “Generate Preview” scherm kan je deze PL/SQL code laten genereren door gebruik te maken van de knop “Show API Call”


28 - 60

iAdvise

Docufy

5 U ITGEWERKT VOORBEELD 5.1

S ITUERING

In dit hoofdstuk wordt een volledig uitgewerkt voorbeeld getoond dat gebruikt maakt van de DEMOtabellen die ook voor de Sample Application in APEX gebruikt worden.

Het voorbeeldrapport is een “Orderbevestiging”. Het toont een brief ter bevestiging van een geplaatste bestelling. Als bijlage bij de brief wordt er een lijst afdrukt met alle bestelde artikels. Je kan het rapport opvragen voor één bepaalde bestelling of voor alle bestellingen samen. Dit laatste resulteert in één brief per bestelling, allemaal achter elkaar samengebundeld in één Word-document.

Uitgewerkt voorbeeld Docufy - Handleiding Versie: 01.01

29 - 60

iAdvise

Docufy


30 - 60

iAdvise

5.2

Docufy

U ITWERKING

Het voorbeeldrapport “Orderbevestiging” ziet er in Docufy als volgt uit.

Deze paragraaf legt uit hoe we tot dit document zijn gekomen.

5.2.1 F OLDER EN DOCUMENT AANMAKEN (S TART ) Maak een nieuwe folder aan of navigeer naar de gewenste folder. Creëer onder deze folder een nieuw document met de naam “Order Confirmation”.

5.2.2 G EGEVENS SELECTEREN (W AT ?) Voor dit rapport hebben we gegevens uit verschillende tabellen nodig. Deze moeten geselecteerd worden via de juiste SQL-statements.

5.2.2.1 O RDERS Uiteraard hebben we de gegevens van de bestellingen zelf nodig. Deze bevinden zich in de tabel DEMO_ORDERS.


31 - 60

iAdvise

Docufy

We willen de mogelijkheid inbouwen om: -

ofwel één brief voor een bestelling naar keuze af te drukken ofwel alle brieven voor alle bestellingen na elkaar af te drukken

Hiervoor hebben we een parameter nodig, nl. P_ORDER_ID. Om deze parameter te kunnen gebruiken in het SQL-statement, moeten we deze eerst aanmaken. Parameters kunnen aangemaakt worden via de tab “Parameters”.

Parameters kunnen we in het SQL-statement vervolgens aanroepen via de dubbelepunt-notatie van de “Bind Variable Name”, bv. :P_ORDER_ID.


32 - 60

iAdvise

Docufy

Klik op de “SQL”-tab of op “SQL Statements” in de boomstructuur om een nieuw SQL-statement aan te maken. Voeg de nodige WHERE-clause toe om de parameter te controleren. Het SQL-statement ziet er als volgt uit: SELECT o.order_id, TO_CHAR(o.order_timestamp, 'fmDD month YYYY', 'nls_date_language=american') order_timestamp, TRIM(TO_CHAR(o.order_total, '999G999D00')) order_total FROM demo_orders o WHERE (o.order_id = :P_ORDER_ID OR :P_ORDER_ID IS NULL)

De kolom ORDER_TIMESTAMP wordt gebruikt om de brief te dateren. De kolom ORDER_TOTAL wordt tweemaal in de brief afgedrukt. Merk op dat ook de kolom ORDER_ID wordt geselecteerd (dit is niet hezelfde als P_ORDER_ID). De kolom ORDER_ID zal als link gebruikt worden tussen de verschillende statements. Dit statement is het master-statement van het rapport. Het heeft zelf dus geen parent. Merk op dat er een “Parameters”-overzichtje rechts van het SQL-statement staat. Via dit “Parameters” kadertje is het eveneens mogelijk om parameters aan te maken of aan te passen. Indien de parameter op een correcte manier in het SQL-statement is opgenomen, zal de parameter in het overzichtje lichtjes in het blauw aangeduid staan. Via “Usage in Document” duiden we de gewenste weergave aan, in dit geval “Page Break”. Dit betekent eigenlijk hetzelfde als “Global Document”, maar dan met de extra functionaliteit dat er voor ieder nieuw order, telkens een impliciete page break zal toegevoegd worden. Op die manier verschijnt elk nieuw order automatisch op een nieuwe pagina. Als “Recordset Code” kiezen we “ORDERS”. De gegevens uit dit statement zullen getoond worden in de “Body of a document”. Bewaar je SQL-statement door op de knop “Create” te klikken.


33 - 60

iAdvise

Docufy

5.2.2.2 C USTOMERS De orderbevestiging wordt in de rechter bovenhoek geadresseerd aan de klant. Om de klantgegevens te kunnen afdrukken, moeten we deze selecteren uit de tabel DEMO_CUSTOMERS. Uiteraard willen we per brief enkel de klantgegevens zien van de klant die die bepaalde bestelling (ORDER_ID uit het vorige SQL-statement) heeft geplaatst waarvoor we de brief afdrukken. Hiervoor voegen we een WHERE-clausule toe aan het statement van de customers, nl. WHERE order_id = :ORDER_ID. Het SQL-statement ziet er als volgt uit: SELECT c.cust_first_name, c.cust_first_name || ' ' || c.cust_last_name cust_name, c.cust_street_address1 || DECODE(c.cust_street_address2, NULL, NULL, ', ' || c.cust_street_address1) cust_street, c.cust_city || ', ' || c.cust_state || ' ' || c.cust_postal_code cust_city FROM demo_orders o JOIN demo_customers c ON o.customer_id = c.customer_id WHERE o.order_id = :ORDER_ID


34 - 60

iAdvise

Docufy

De orders zijn in dit geval dus de “masters”, terwijl de customer-gegevens de “details”zijn van een bepaald order. Als “Parent SQL Statement” vullen we daarom het SQL-statement “Orders” in. Door het parent-statement in te vullen, krijg je rechts een overzichtje “Link Variables” te zien met alle kolommen uit dit parent-statement. Deze kolommen kunnen gebruikt worden om het detail-statement met het parent-statement te koppelen, het zijn m.a.w. de mogelijke te linken kolommen. Indien je het parent-statement “Orders” correct hebt aangemaakt, zal de kolom ORDER_ID tussen de “Link Variables” staan. Het refereren naar de link variabele, gebeurt opnieuw via de dubbelepuntnotatie. Als ook dit correct gebeurd is, zal de link variabele in het overzichtje lichtjes in het blauw aangeduid staan. (Een groen vinkje verschijnt indien de link opgeslagen is.) Via “Usage in Document” duiden we de gewenste weergave aan, in dit geval “Global document”. Als “Recordset Code” kiezen we “CUSTOMERS”. De gegevens uit dit statement zullen getoond worden in de “Body of a document”. Bewaar je SQL-statement door op de knop “Create” te klikken.


35 - 60

iAdvise

Docufy

Merk ook op dat in de boomstructuur links je eveneens de master-detail structuur gevisualiseerd ziet tussen de verschillende queries.

5.2.2.3 I TEMS (L IST ) De items worden in dit rapport tweemaal afgedrukt en dit telkens in een andere weergave. In de brief worden de bestelde items weergegeven in een lijst. In de bijlage op het tweede blad worden de items getoond in een tabeloverzicht. Voor de lijst hebben we slechts twee kolommen nodig, nl. de naam van het product en de prijs. Bovendien willen we ook hier ook enkel die bestelde items voor de bestelling die we net aan het afdrukken zijn. Dit laatste doen we opnieuw door een WHERE-clausule toe te voegen, nl. WHERE order_id = :ORDER_ID, met ORDER_ID de kolom uit het parent SQL-statement “Orders”. Het SQL-statement ziet er dan als volgt uit: SELECT p.product_name, TRIM(TO_CHAR(i.unit_price * i.quantity, '999G999D00')) total_price FROM demo_order_items i JOIN demo_product_info p ON i.product_id = p.product_id WHERE i.order_id = :ORDER_ID ORDER BY p.product_name

Als “Parent SQL” vullen we het SQL-statement “Orders” in. Via “Usage in Document” duiden we de gewenste weergave aan, in dit geval “List”. Als “Recordset Code” kiezen we “ITEM_LIST”. De gegevens uit dit statement zullen getoond worden in de “Body of a document”. Tenslotte kijken we na of de gebruikte link variabele ORDER_ID lichtjes blauw geaccentueerd staat. Bewaar je SQL-statement door op de knop “Create” te klikken.


36 - 60

iAdvise

Docufy

5.2.2.4 I TEMS ( TABLE ) Eigenlijk hebben we in dit rapport tweemaal bijna gelijke gegevens nodig. Deze gegevens hoef je dan ook slechts één keer te selecteren via eenzelfde SQL-statement. Dit SQL-statement is analoog aan het SQL-statement voor “Items (list)”. We hebben enkel wat extra kolommen nodig, waaronder een BLOB-kolom voor de afbeelding van het product. We kunnen dit statement dus gewoon uitbreiden met de nodige extra kolommen. Het SQL-statement ziet er als volgt uit: SELECT p.product_name, p.product_description, TRIM(TO_CHAR(i.unit_price, '999G999D00')) unit_price, i.quantity, TRIM(TO_CHAR(i.unit_price * i.quantity, '999G999D00')) total_price, DECODE(p.product_avail, 'Y', 1, 0) product_avail, p.product_image "photo", SIGN(NVL(dbms_lob.getlength(p.product_image), 0)) check_photo FROM demo_order_items i JOIN demo_product_info p ON i.product_id = p.product_id WHERE i.order_id = :ORDER_ID ORDER BY p.product_name


37 - 60

iAdvise

Docufy

Merk eveneens op dat nog twee kolommen zijn toegevoegd die in de template zullen dienen voor het conditioneel weergeven van gegevens: 1. De kolom PRODUCT_AVAIL geeft de waarden 1 of 0 terug, respectievelijk om aan te duiden of het product nog beschikbaar is of niet. Indien het product beschikbaar is, zal deze in het zwart afgedrukt worden. Is het niet meer beschikbaar, dan verschijnt het betreffende product in het rood. 2. De kolom CHECK_PHOTO is nodig om een “lege foto” te tonen indien er geen BLOB voor het bepaalde product wordt teruggevonden in de databank. Deze kolom geeft eveneens 1(foto in databank) of 0 (geen foto in databank) terug. Wijzig het statement van het “Items”-statement. Vervolgens moeten we nog aanduiden dat we een extra weergave van de gegevens wensen, nl. een table-layout. Hiervoor klikken we bij “Usage in Document” onderaan gewoon op de knop “Add”. Op deze manier kunnen we zoveel weergaves toevoegen als we willen. In dit voorbeeld kiezen we voor “Table”. Als “Recordset Code” vullen we de unieke code “ITEM_TABLE” in. De table zal getoond worden in de “Body of a document”. Bewaar de aanpassingen aan je SQL-statement door op de knop “Save Changes” te klikken.


38 - 60

iAdvise

Docufy

5.2.2.5 P RODUCT AVAILABLE Indien er minstens één product uit de bestelde items niet meer beschikbaar is, wensen we onderaan het rapport nog een extra waarschuwing te tonen. Ook hiervoor hebben we een soort “check”-kolom nodig. Deze selecteren we via het laatste SQL-statement “Product avail”. Uiteraard moet deze check enkel gebeuren voor de items uit de bestelling die we net aan het afdrukken zijn. Dit laatste doen we opnieuw door een WHERE-clausule toe te voegen, nl. WHERE order_id = :ORDER_ID. Het SQL-statement ziet er als volgt uit: SELECT FROM JOIN WHERE AND

SIGN(COUNT(1)) check_product_avail demo_order_items i demo_product_info p ON i.product_id = p.product_id i.order_id = :ORDER_ID p.product_avail <> 'Y'

Als “Parent SQL” vullen we het SQL-statement “Orders” in. Via “Usage in Document” duiden we de gewenste weergave aan, in dit geval “Global document”. Als “Recordset Code” kiezen we “PRODUCT_AVAIL”. De gegevens uit dit statement zullen getoond worden in de “Body of a document”. Tenslotte kijken we na of de gebruikte link variabele ORDER_ID lichtjes blauw geaccentueerd staat. Bewaar je SQL-statement door op de knop “Create” te klikken.


39 - 60

iAdvise

Docufy

5.2.3 T EMPLATE AANMAKEN (H OE ?) De template bestaat uit twee pagina’s: 1. De eerste pagina bevat de brief aan de klant, met een overzicht van de bestelde artikels in een opsommingslijst. 2. De tweede pagina bevat de bijlage die een overzichtstabel toont van de bestelde artikels met telkens een foto van het betreffende product.


40 - 60

iAdvise

Docufy

5.2.3.1 D E BRIEF


41 - 60

iAdvise

Docufy

Vaste afbeelding in de template De brief toont in de linker bovenhoek het logo van de firma. Dit kan heel eenvoudig door het logo in het Word-document te importeren. Microsoft Word-functionaliteiten Kopteksten en voetnoten zijn eveneens functionaliteiten uit Microsoft Word die eenvoudig kunnen worden toegevoegd. Toevoegen van gegevens uit de databank Op plaatsen waar je in de brief gegevens wenst te noteren uit de databank, kan je dit heel eenvoudig doen via de notatie[BEGIN: MY_RECORDSET_CODE][MY_COLUMN_NAME] [END: MY_RECORDSET_CODE], vb. [BEGIN: CUSTOMERS+*CUST_NAME+ … *END: CUSTOMERS] Deze codes moeten exact overeenkomen met de kolom-aliassen uit de SQL-statements. Merk op dat de tags voor het sluiten van de Recordset Codes “CUSTOMERS” en “ORDERS” niet op deze pagina staan. Deze komen op het einde van de bijlage op de volgende pagina. Op die manier kunnen we op de volgende pagina ook nog kolommen uit deze statements aanroepen. De aandachtige lezer heeft bovendien onthouden dat we bij “ORDERS” als “Usage in Document” gekozen hebben voor “Page Break”. Zo zal er voor elk nieuw order ook telkens een nieuwe pagina begonnen worden. Opsommingslijsten Het weergeven van een opsommingslijst kan via de notatie:  [BEGIN:ORDERS][CUST_NAME] – [ORDER_DATE] - €[ORDER_TOTAL][END:ORDERS] De codes voor de recordset en voor de kolommen moeten ook hier exact overeenkomen.


42 - 60

iAdvise

Docufy

5.2.3.2 D E BIJLAGE


43 - 60

iAdvise

Docufy

Tabellen Het weergeven van gegevens in een tabel kan via de notatie: Product Description [BEGIN:ITEMS_TABLE][ [PRODUCT_DESCRIPTION] PRODUCT_NAME]

… …

Extended Price in € [TOTAL_PRICE][END:ITEMS _TABLE]

Conditionele weergave Het conditioneel weergeven van gegevens gebeurt via de notatie: [IF:MY_CHECK+ … inhoud indien MY_CHECK = 1 … [ELSE:MY_CHECK+ … inhoud indien MY_CHECK = 0 … (niet verplicht te noteren, indien leeg) [ENDIF:MY_CHECK] Hierbij is MY_CHECK een kolom uit een SQL-statement die 1 of 0 teruggeeft. Wil je bijvoorbeeld het aantal bestelde producten noteren in het zwart, indien het product nog beschikbaar is, maar daarentegen duidelijk accentueren in het rood, indien deze niet meer in voorraad is, dan wordt dit (let hierbij op het kleurgebruik): [IF:PRODUCT_AVAIL][QUANTITY][ELSE:PRODUCT_AVAIL][QUANTITY][ENDIF:PRODUCT_AVAIL] Wil je onderaan een waarschuwing tonen in het rood, indien één van de producten niet meer beschikbaar is (voor deze check is een apart SQL-statement “Product avail” geschreven), dan wordt dit: [BEGIN:PRODUCT_AVAIL][IF:CHECK_PRODUCT_AVAIL](*) This product is currently not in stock, your order may be delayed. [ELSE:CHECK_PRODUCT_AVAIL][ENDIF:CHECK_PRODUCT_AVAIL] [END:PRODUCT_AVAIL] Afbeeldingen uit de databank Om afbeeldingen uit de databank weer te geven, moet je een aantal stappen doorlopen: 1. Je maakt of zoekt een dummy-afbeelding die de gewenste afmetingen heeft. In deze template is hiervoor een afbeelding van een postpakketje gebruikt. 2. Je geeft deze dummy-afbeelding een naam, bv. “photo.jpg”. De naam van deze afbeelding is heel belangrijk en moet exact dezelfde naam (excl. de extensie) zijn als de alias voor de BLOBkolom. Vermits de naam van het bestand “photo.jpg” is in kleine letters, moet de alias voor de BLOB-kolom dus “photo” zijn (met dubbele aanhalingstekens en lowercase). 3. Je voegt de dummy-afbeelding toe aan je Word-template op de gewenste plaats. Docufy zal automatisch alle afbeeldingen met dezelfde naam als de geselecteerde BLOB-kolom vervangen door de juiste afbeelding uit de databank. Er is dus geen specifieke syntax vereist voor het tonen van afbeeldingen uit de databank.


44 - 60

iAdvise

Docufy

6 TIPS & TRICKS Op dit moment beschik je over voldoende informatie om zelf aan de slag te gaan met Docufy. Toch zal je af en toe nog vragen hebben bij hoe je een bepaald probleem moet aanpakken. We kunnen jammer genoeg niet alles behandelen in deze handleiding. We willen je uiteraard wel op de hoogte houden van interessante weetjes en je oplossingen aanbieden voor veel voorkomende vragen.

Onze website http://www.Docufy.be is hier het ideale hulpmiddel voor. We raden je aan geregeld onze website te bezoeken om op de hoogte te blijven van allerlei tips & tricks.

Tips & tricks Docufy - Handleiding Versie: 01.01

45 - 60

iAdvise

Docufy

Heb je zelf een probleem en zoek je hier een oplossing voor, aarzel dan niet ons te contacteren via [email protected]. We zullen je vraag zo snel mogelijk proberen te bekijken en je een oplossing aanbieden. Wie weet verschijnen de omschrijving en de bijhorende oplossing van jouw probleem wel in het lijstje van de tips & tricks en kunnen ze op die manier een hulp betekenen voor andere Docufygebruikers.

Tips & tricks Docufy - Handleiding Versie: 01.01

46 - 60

iAdvise

Docufy

7 DEPLOYMENT Wanneer je een document van een ontwikkelomgeving wilt overzetten naar een test- of productieomgeving, dan kan je gebruik maken van de export / import functionaliteit die voorzien is binnen de applicatie. Momenteel is het enkel mogelijk een export en import uit te voeren per individueel document.

7.1 E XPORTEREN VAN EEN DOCUMENT Het exporteren van een document wordt gestuurd vanuit een document. Om een document te exporteren, kan je het gewenste document selecteren via de boomstructuur. Als je het “Actions”-menu openklapt, zie je een “Export” optie.

Bij het kiezen van de “Export” optie, wordt automatisch een SQL-bestand aangemaakt dat alle metadata en definities van het gekozen document bevat, bvb. Docufy_export_Order_Confirmat.sql en vraagt het systeem dit bestand op een plaats naar keuze te bewaren.

7.2 I MPORTEREN VAN EEN DOCUMENT Het importeren van een document wordt gestuurd vanuit een folder. Om een document te importeren, kan je via de boomstructuur de folder selecteren waaronder het document moet worden aangemaakt. Als je het “Actions”-menu openklapt, zie je een “Import Document” optie.

Deployment Docufy - Handleiding Versie: 01.01

47 - 60

iAdvise

Docufy

Bij het kiezen van de “Import Document” optie, wordt een popup-scherm geopend waarin je het geëxporteerde SQL-bestand kan ophalen. Als je vervolgens op “Import” klikt, wordt het bestand opgeladen en worden de definities aangemaakt in de Docufy metadata tabellen. Let wel op! Indien de gekozen folder reeds een document met dezelfde naam bevat, dan wordt deze laatste overschreven.

Deployment Docufy - Handleiding Versie: 01.01

48 - 60

iAdvise

Docufy

8 ADMIN MOGELIJKHEDEN De “Admin” mogelijkheden kan je terugvinden door in de rechterbovenhoek het menu achter de aangemelde gebruiker open te klappen. Enkel indien je als gebruiker voldoende rechten hebt, heb je toegang tot deze Admin pagina’s.

8.1 U SERBEHEER Eén van de items die je terugvindt onder de Admin-pagina’s, zijn de “Users”.

Hier kan je gebruikers aanmaken (via de knop “Create”), beheren (door op de gebruikersnaam te klikken) of verwijderen (door op het vuilbak-icoontje te klikken).

Admin mogelijkheden Docufy - Handleiding Versie: 01.01

49 - 60

iAdvise

Docufy

Een gebruiker heeft steeds een “Username” (om aan te melden) en een volledige naam. Het paswoord kan hier eveneens beheerd worden. Merk ook op dat je aan elke gebruiker “Roles” kan koppelen. Er zijn drie soorten roles voorzien: 1. Administrator: de belangrijkste gebruiker van de toepassing, die toegang heeft tot alle onderdelen van de toepassing 2. Document Editor: deze gebruiker kan folders en documenten aanmaken en beheren. Hij heeft echter geen toegang tot de Admin pagina’s 3. Viewer / Reader: deze gebruiker kan de gegevens in folders en documenten enkel lezen. Hij kan geen nieuwe folders of documenten aanmaken en er ook geen wijzigingen in aanbrengen Onderaan op deze pagina kan u tenslotte bepalen tot welke folder(s) een gebruiker toegang heeft.


50 - 60

iAdvise

Docufy

8.2 L OGGING Hoewel het Docufy team zijn uiterste best heeft gedaan om deze Docufy toepassing zo foutloos en kwaliteitsvol mogelijk op te leveren, kan het altijd zijn dat er nog fouten zijn ingeslopen. Wij raden je aan om, in het geval je een mogelijke fout tegenkomt, contact op te nemen met het support team van Docufy ([email protected]). Afhankelijk van het probleem is het mogelijk dat wij je zullen vragen om bepaalde packages te tracen. Dit is mogelijk via de twee logging pagina’s “Log Configs” en “Log Messages”.

8.2.1 L OG CONFIGURATIONS Op de “Log Configs” pagina kan je het niveau van de logging instellen per package. Deze bepaalt het niveau van de ernst van de boodschappen die moeten doorgelaten en gelogd worden bij het uitvoeren van de package. De log levels variëren van 1 tot 6 waarbij log level 1 het meest strenge niveau is en dus het minst aantal boodschappen doorlaat: enkel de error-boodschappen worden getoond. Log level 6 laat dan weer alle boodschappen door, zoals errors en waarschuwingen, maar ook gewone informatie. Dit is heel nuttig om de code te debuggen.


51 - 60

iAdvise

Docufy

8.2.2 L OG MESSAGES De resultaten van de tracing worden zichtbaar gemaakt op de “Log Messages” pagina. Je krijgt hier een overzicht van alle boodschappen die je hebt laten genereren. Deze boodschappen kunnen via het “Actions”-menu geëxporteerd worden en doorgestuurd worden naar het Docufy team die ze zal analyseren. De verkregen boodschappen kunnen voor het Docufy team nuttige informatie opleveren om de fouten op te sporen en op te lossen.

Het boodschappenoverzicht kan weer leeggemaakt worden via de knop “Purge”.


52 - 60

iAdvise

Docufy

8.3 B EHEREN VAN LICENTIES Via de optie “License” kan je je license keys beheren. Standaard zal je hier “TRIAL” ingevuld zien staan. Dit betekent dat je met een gratis trial versie van Docufy aan het werken bent. Deze trial versie biedt je dezelfde mogelijkheden als de betalende versie, zonder enige functionele beperking. Je zal enkel op elk gegenereerd document een soort watermark zien verschijnen.

Een licentie van Docufy aankopen, kan je doen via de website http://www.Docufy.be of door een mailtje te sturen naar [email protected]. Een licentie is geldig per Oracle database instance. Wij zullen je vragen om ons de database instance naam te bezorgen die we nodig hebben om een unieke key voor jou te maken. Wij zenden je dan de key terug die je op deze pagina dient in te vullen. Meer informatie betreffende de prijzen, de licentieduur en de support, kan je eveneens terugvinden op onze website.


53 - 60

iAdvise

Docufy

9 OVER I ADVISE

Uw Oracle en Java specialist

9.1 O RACLE EN J AVA OPLOSSINGEN Steeds een stap vooruit in oplossingen op basis van de meest actuele Oracle en Java technologie, in België en Nederland. Wij structureren uw data, bouwen de applicaties waarmee die data bewerkt wordt, en we verzorgen het platform waarop deze applicaties draaien.

9.2 C ONTACT INFORMATIE Kantoor België Business Park King Square Veldkant 33b - 2550 Kontich Tel.: +32 (0)3 451 93 28

Kantoor Nederland Neerloopweg 36 4814 RS Breda Tel.: +31 (0)76 711 54 00

iAdvise http://www.iadvise.be [email protected]

iAdvise http://www.iadvise.nl [email protected]

Docufy http://www.Docufy.be [email protected]

Docufy http://www.Docufy.nl [email protected]

Over iAdvise Docufy - Handleiding Versie: 01.01

54 - 60

iAdvise

Docufy

APPENDIX INSTALLATIE I NLEIDING Docufy 01.01 komt als een export bestand van een Packaged Application voor APEX. Dit bestand bevat dus 1) zowel de APEX UI 2) als alle database objecten als “supporting objects”. Het installatieproces bestaat uit de volgende stappen 1. Maak een specifiek Docufy database schema aan 2. Maak een workspace in APEX aan en koppel hieronder het Docufy database schema 3. Meld aan op deze workspace en importeer hierin de toegezonden APEX export file, inclusief de “Supporting Objects”. Deze appendix geeft u de te volgen installatiestappen bij dit derde puntje.

I NSTALLATIESTAPPEN BINNEN APEX Deze installatieprocedure gaat ervan uit dat u reeds een APEX-omgeving geïnstalleerd of ter beschikking heeft, met toegang tot een workspace waarin u de Docufy toepassing mag installeren. We starten in een APEX omgeving en klikken op de “Create” knop om een applicatie toe te voegen.

APPENDIX Installatie Docufy - Handleiding Versie: 01.01

55 - 60

iAdvise

Docufy

In de eerste stap selecteer je welk bestand je wil opladen. We duiden hierbij aan dat het gaat om een “Database Application”. Klik op “Next” om naar de volgende stap te gaan.

Het bestand wordt geïmporteerd. Klik op “Next” om de Docufy toepassing te installeren.


56 - 60

iAdvise

Docufy

In de volgende stap selecteer je op welk schema alle packages van Docufy geïnstalleerd mogen worden. Kies het juiste “Parsing Schema” en de gewenste “Build Satus”, in dit geval zijn dit respectievelijk parsing database schema “DG4O_0101” en build status “Run and Build Application”. Vervolgens selecteer je een optie voor het genereren van de juiste “Application ID” voor de Docufy toepassing. Klik op “Install Application”.

De applicatie wordt nu geïnstalleerd. Als dit voltooid is, krijg je de vraag of je de “Supporting Objects” wilt installeren. Deze “Supporting Objects” bevatten alle nodige Docufy objecten + de PL/SQL engine.


57 - 60

iAdvise

Docufy

Beantwoord de vraag bevestigend via het aanklikken van de optie “Yes” en klik vervolgens op “Next”.

Bevestig tenslotte dat de installatie uitgevoerd mag worden. De installatie zal voltooid worden. Indien je nog de image folder wenst aan te passen, dan kan dat door na de installatie te kiezen voor “Edit application”.


58 - 60

iAdvise

Docufy

Kies vervolgens voor “Edit Application Properties” zoals in de afbeelding hieronder.

Klik op het vierde tabje “User Interface”. Je ziet nu in de region “General Properties” het labeltje “Image Prefix” staan. Verander dit naar de prefix die voor jouw omgeving van kracht is (bijvoorbeeld: /p/).

Klik op “Apply Changes” en run de Docufy toepassing.


59 - 60

iAdvise

Docufy

Je kan aanmelden tot de toepassing met de standaard aangemaakte gebruiker admin/admin. Wij raden u aan dit paswoord aan te passen naar de eigen specifieke vereisten.

Als alles goed verlopen is, krijg je de onderstaande pagina te zien.

Je kan nu starten met Docufy!


60 - 60

Handleiding. Versie Laatste wijziging: Ontwikkeld door iadvise. w: m:

Recommend Documents