DocuGen
Provocare:
Mulți dintre noi suntem probabil familiarizați cu faptul că, după ce a fost dezvoltată o aplicație Qlik Sense™, este necesară documentația pentru a transfera analiza în producție. Acest proces este consumator de timp și necesită mai multe zile de muncă pentru a obține în cele din urmă o „bucată de hârtie”. Documentația poate fi obligatorie atât din motive de reglementare, cât și operaționale. Urmând principiul „Să lucrăm mai inteligent”, ați putea automatiza exact acest proces cu DocuGen utilizând Qlik™ Application Automation. Acest lucru poate economisi timp prețios și ne poate oferi posibilitatea de a transfera cazuri de utilizare în producție și mai rapid.
Idee:
Totul a început cu această idee simplă și un prim prototip, construit în Qlik™ Application Automation. Diverse blocuri Qlik™ Cloud Services sunt utilizate pentru a extrage metadatele relevante din aplicația individuală (de exemplu, definiții de tabele, pagini și vizualizări, variabile, măsuri și dimensiuni etc.). Aceste date sunt apoi stocate în variabile și, odată ce toate informațiile au fost colectate, acestea sunt trecute într-un bloc „Custom Code”. Acest bloc utilizează Python 3.11 și creează un fișier HTML dinamic fără referințe externe. Aceasta înseamnă că fișierul HTML creat rămâne transportabil și nu necesită resurse externe, deoarece conține toate funcțiile necesare. În cele din urmă, fișierul HTML creat este salvat în MS Sharepoint.
Rezultat:
Această abordare ne ajută să creăm zilnic documentația standard mult mai rapid (înainte, aproximativ 3 – 5 zile; acum ~ 30 de minute). În activitatea de zi cu zi, un specialist în BI poate acum să transfere prototipurile de analiză în producție mult mai rapid pentru clienți săi și să ofere și mai rapid valoare adăugată departamentelor de business. Sunt specialiști în BI care se confruntă cu aceeași provocare și de aceea, câțiva membri ai echipei de la Qlik™ au reușit să creeze un proiect comunitar, pornind de la această idee. Așadar, documentația a fost extinsă cu mai multe funcționalități, a fost generalizat designul documentației și codul a fost rescris.
Mai jos, vă vom prezenta acest proiect, pregătit de specialiștii de la Qlik™.
Conținutul pachetului:
Arhiva constă din doar 4 fișiere:
Pentru a importa Qlik™ Application Automation aveți nevoie de fișierul DocuGen v(x).json. Acest fișier conține spațiul de lucru Qlik™ Application Automation exportat.
Folderul „code” conține segmentele de cod utilizate în cazul în care doriți să personalizați codul pentru nevoile dvs.
- custom_code_block.py: Acest fișier conține codul pe care îl folosim în blogul „Cod personalizat” din automatizare.
- used_css.css: Acest fișier conține definiția CSS pe care o folosim în blogul „Variable – vCSS” în automatizare și importă descrierea stilului pentru fișierul nostru HTML. Definiția nu este minificată în acest fișier.
- used_js.js: Acest fișier conține scripturile Java pe care le folosim în scriptul nostru Python (custom_code_block.py chiar la sfârșit). JavaScript-ul este implementat în codul Python (ultima secțiune <script></script>). Este important ca ‘{‘ și ‘}’ să fie înlocuite cu ‘{{‘ și ‘}}’, astfel încât să nu fie evaluate în Python.
Instalare:
1. Creați o nouă aplicație Qlik™ Application Automation goală
2. Încărcați spațiul de lucru (faceți clic dreapta pe canvas) à DocuGen v_(x)_.json
3. Creați o conexiune pentru SharePoint
a. derulați până în partea de jos și faceți clic pe Blocul “Create File on Microsoft SharePoint” care are o margine roșie
b. faceți clic pe fila Connection și creați o conexiune la Microsoft SharePoint
c. după ce primiți informația „Connection is linked” o puteți utiliza făcând clic pe conexiunea creată. Fila conexiune ar trebui să își schimbe acum culoarea din roșu în negru.
d. faceți clic pe „Inputs” și selectați Drive Id sau Site Id pentru a vă alege destinația în SharePoint. Puteți, de asemenea, să schimbați ultimele 3 blocuri și să utilizați o altă locație de stocare pentru rapoartele dvs. generate.
4. (optional) Dacă doriți să schimbați formatul numărului de la „virgulă” la „punct” ca separator zecimal, puteți schimba valoarea blocului numit „Variable – vNumber Format” de la „de” la „us”. Acesta este al doilea bloc al automatizării.
5. Acum puteți rula automatizarea pentru a genera prima documentație
Rularea automatizării:
Atunci când faceți clic pe „Run”, automatizarea este executată. În mod implicit, automatizarea are configurat „Run Mode: Manual”. Aceasta necesită câteva intrări pentru procesare:
- Spațiu – locul în care este localizată aplicația (Personal nu funcționează)
- Nume aplicație
- Lista secțiunilor care trebuie documentate (de exemplu, modelul de date, măsurile, dimensiunile etc.)
- Capturi de ecran (da/nu)
- Lista pentru tipul de pagini (de exemplu, publice, comunitare, private)
Notă
Dacă doriți să executați automatizarea declanșată (de exemplu, prin apel REST), aceasta trebuie să fie modificată. Vom posta un exemplu mai târziu pentru a prezenta această opțiune.
Caracteristici:
Această listă evidențiază ce acoperă DocuGen:
- Informații generale despre aplicație:
- numele aplicației, descrierea, Id, tipul de resursă, tipul de utilizare, proprietarul, publicat, ora publicării, Id spațiu, are acces la secțiune, este criptat, data creării, data modificării, ora ultimei reîncărcări, amprenta de memorie a aplicației, vârf de reîncărcare a aplicației RAM
- Model de date:
- Pentru fiecare tabel se generează:
- titlu, număr de rânduri, număr de câmpuri, număr de câmpuri cheie, este liber, comentariu, dimensiunea tabelului,
- tabel care conține numele câmpului, număr de valori distincte, număr de valori nenule, etichete, este ascuns, este cheie, tabele conectate
- Pentru fiecare tabel se generează:
- Măsuri:
- Pentru fiecare măsură se generează:
- titlu, etichetă, descriere, Id, definiție, expresie, grupare, formatat personalizat, tip de format, format, culoare, etichete
- Pentru fiecare măsură se generează:
- Dimensiuni:
- Pentru fiecare dimensiune se generează:
- titlu, etichetă, descriere, Id, definiție, grupare, etichete
- Pentru fiecare dimensiune se generează:
- Variabile:
- Pentru fiecare variabilă se generează:
- titlu, Id, definiție, comentariu, etichete
- Pentru fiecare variabilă se generează:
- Pagini & Vizualizări:
- lista de pagini
- pentru fiecare pagină se generează titlul, tipul, Id, descrierea, rezoluția grilei, modul paginii, lista obiectelor utilizate
- link la pagină
- lista de obiecte de pe foaie
- pentru fiecare obiect de pe o pagină, generează captură de ecran, tip, Id, titlu, subtitlu, notă de subsol, mod de culoare, definiția culorii, dimensiuni, măsuri, link către obiect
- dacă obiectul este un container (container layout, container cu taburi sau container normal), se creează o listă a tuturor obiectelor copil care conține următoarele informații:
- tip, Id, titlu, subtitlu, notă de subsol, mod de culoare, definiția culorii, dimensiuni, măsuri, link către obiect
- lista de pagini
- Încărcare script:
- Pentru fiecare secțiune de script generează:
- titlu, script
- Pentru fiecare secțiune de script generează:
Sperăm că acest proiect vă poată ajuta să vă automatizați și să vă minimizați eforturile de documentare.
Pentru o demonstrație despre DocuGen, vă rugăm să urmăriți materialul video de mai jos:
Sursă articol: https://github.com/djaskowiak/
Pentru informații despre Qlik™, clic aici: qlik.com.
Pentru soluții specifice și specializate de la QQinfo, clic aici: QQsolutions.
Pentru a fi în contact cu ultimele noutăți în domeniu, soluții inedite explicate, dar și cu perspectivele noastre personale în ceea ce privește lumea managementului, a datelor și a analiticelor, clic aici: QQblog !