Funktionsbeskrivning

Transkript

1 Funktionsbeskrivning UND-07-T-06 DB03 Funktionalitet för att upptäcka fel i databasen Version: Beteckning: Status: 1.0 UND-07-T-06

2 Ändringshistorik Revision Datum Av Kommentar Granskare Godkännare Markus Umefjord Första utkast Markus Umefjord Ändrade inriktning, lade till beskrivning för handhavande i Nouveau, samt listar tillgängliga styrfiler och förväntat rapportformat Markus Umefjord Ändringar och rättningar utifrån synpunkter från Torgny Fridlund Markus Umefjord Uppdaterad kontaktinformation Markus Umefjord Ändringar utifrån synpunkter från Daniel Lind och Thomas Dahlberg Markus Umefjord Ändring i krav: Krav 6 har bytt namn, separatorsträng är ~#~ istället för ~, efter önskemål från Thomas Dahlberg och Daniel Lind Markus Umefjord Ändrad nomenklatur. Begreppet styrfil utgår till förmån för regelfil enligt önskemål från Ladokenheten och konsensus på projektmöte. Förtydligande i stycke 4.2 efter önskemål från Hans Persson Daniel Lind Ändrat bild för villkorsformulär Erik Adamsson Uppdaterar skärmbilder Magnus Böhlin Uppdatera hur batchen fungerar Britt Berglund Lagt till preferensstyrning SUPER Magnus Böhlin Uppdatera hur resultatet presenteras(sortering av filer samt att filer med resultat=0 inte ska med i zip en)

3 Markus Umefjord UND-07-T-06 3 (14) Innehållsförteckning 1 INLEDNING SYFTE ENKEL ÖVERSIKT PREFERENSSTYRNING BATCHBESTÄLLNING ÖVERSIKT FLÖDE FORMULÄR Beställningsformuläret Villkorsformuläret FUNKTIONSBESKRIVNING UPPFÖLJNING ÖVERSIKT FLÖDE FORMULÄR HÄMTA FIL INPUT OCH OUTPUT REGELFILER Mer information RAPPORTFILER Strängseparerade värden SELECT-satser Sammanställning... 12

4 Markus Umefjord UND-07-T-06 4 (14) 1 Inledning 1.1 Syfte Syftet med detta dokument är att beskriva hur man aktiverar och följer upp batchen DB03 som hittar felaktigheter i databasen. 1.2 Enkel översikt DB03 är en batch som läser en eller flera regelfiler från disk, tolkar dessa samt exekverar den SQL-kod som finns i regelfilerna och genererar rapportfiler utifrån det utsökta resultatet. För varje regelfil som gör läsningar(sql-satser) ska batchen generera två olika rapportformat utifrån samma data. Rapportfilerna skrivs till disk och görs tillgängliga för läsning via Nouveaugränssnittet. För de regelfiler som gör ändringar (UPDATE, INSERT, DELETE) så skrivs inga rapportfiler, resultatet går att läsa i Sammanställningen. 1.3 Preferensstyrning Funk Nr Vad vill man styra Nyckelord Värde: Resultat Default Typ 1 ) DB03 1 Lägg till/ta bort/ ändra andras SUPER J: Visar alla beställningar N A beställningar N: Endast användarens beställningar 1) Typ betyder: S: SYSTPREF, A: ANVPREF, P: PERSPREF

5 Markus Umefjord UND-07-T-06 5 (14) 2 Batchbeställning 2.1 Översikt Användaren skapar en batchbeställning i den generella batchbeställningsfunktionen i Nouveau genom att välja funktionen DB03. I batchbeställningsformuläret kan användaren ange en beteckning, tidpunkt för beställningen. Användaren kan även välja en eller flera regelfiler för körningen via villkorsformuläret. Görs inget val av regelfiler kommer beställningen att gå utan att några regelfiler körs. 2.2 Flöde 1. Användaren väljer funktionen DB03 2. Beställningsformuläret öppnas 3. Användaren anger beteckning, tidpunkt, eventuell periodicitet. 4. Användaren sparar beställningen genom att klicka på Uppdatera. 5. Val av regelfiler görs genom att: a. Användaren klickar på knappen Villkor b. Användaren väljer en eller flera regelfiler. c. Användaren sparar villkoren genom att klicka på knappen Uppdatera.

6 Markus Umefjord UND-07-T-06 6 (14) 2.3 Formulär Beställningsformuläret I batchbeställningsformuläret anger man en valfri (unik) beteckning och när i tiden batchen ska köras.

7 Markus Umefjord UND-07-T-06 7 (14) Villkorsformuläret I villkorsformuläret väljer användaren en eller flera regelfiler som ska aktiveras när batchen startar. Tillgängliga regler återfinns på under Nouveau-funktionen DB Funktionsbeskrivning DB03 - [Upptäcka/justera fel i databasen]

8 Markus Umefjord UND-07-T-06 8 (14) Senast uppdaterad: Allmänt I denna funktion ska du ange de regelfiler som ska aktiveras vid körning av batchen. Om inga regelfiler anges tolkas detta som om att inga regelfiler ska vara aktiva. Om man byter produkt, typ eller handbok rensas tidigare val under valda regelfiler. Välj produkt Listan med 'Tillgängliga regelfiler' uppdateras automatiskt beroende på vilket val som gjorts. Alternativ 'Ladok' visar alla Ladok skript, 'Ladok3' visar Ladok3 skript och 'Alla skript' visar både Ladok och Ladok3 skript. Välj typ Här väljer man typ av skript. Det går bara att välja 'Uppdateringsskript' om man valt produkt Ladok3. Välj handbok Det går även att filtrera på handbok. Dropdownlistan innehåller de handböcker som finns tillgängliga. Dropdownlistan är endast tillgänglig då man valt produkt 'Ladok3'. Välj filer Du kan ange en eller flera regelfiler som ska aktiveras. Du anger regelfiler genom att markera dem i listan 'Tillgängliga regelfiler' och föra över dem till listan 'Valda regelfiler'. Du kan dubbelklicka, använda knapparna eller markera och trycka på entertangenten på det numeriska tangentbordet för att föra regelfiler mellan listorna. Du kan även välja flera koder på engång i listan genom att klicka i listan och antingen hålla Ctrl-tangenten nertryckt eller Shift-tangenten. Ta bort 'Valda regelfiler' fungerar på samma sätt som att lägga till. För att välja samtliga regelfiler kan man göra på två sätt. Antingen trycker man på knappen 'Välj alla' eller så lämnar man 'Valda regelfiler' blankt och aktiverar Uppdatera. Man får då svara på en fråga om samtliga regelfiler skall användas. Svarar man 'Ja' väljs alla regelfiler, svarar man 'Nej' skickas man tillbaka till villkorsformuläret. Kompletterande information vid val av filer Väljer du flera regelfiler för uppdatering som avser samma tabell kan vi inte garantera körordningen och detta i sin tur medför att det kan uppstå problem med tabellen.

9 Markus Umefjord UND-07-T-06 9 (14) 3 Uppföljning 3.1 Översikt När batchen kört klart kommer den att meddela beställaren av batchen via ett e-postmeddelande att den är klar. I det läget ska användaren hämta de genererade rapportfilerna via beställningsformulärets Hämta-fil -funktion. När filerna laddats ner till den egna datorn kan man analysera utfallet av batchen. Det är endast regelfilerna med utsökning som genererar rapportfil. Regelfilerna som gör ändringar skriver endast resultat till Sammanställningen. Har inga regelfiler valts körs beställningen med noll filer och i mailet som skickas ut till användaren ges upplysningen Inga filer behandlade eftersom det saknades villkor till körningen. I detta läge skapas inte några rapportfiler. 3.2 Flöde 1. Batchen meddelar användaren att den är klar genom att skicka ett e-postmeddelande. a. Om användaren av någon anledning inte kan ta emot e-post kan han/hon gå in i beställningsformuläret och hämta filerna manuellt. Man kan kontrollera att Körstatus är satt till KLAR för att se om batchen kört klart eller inte. 2. Användaren startar funktionen DB03 i Nouveau 3. Användaren söker fram sin beställning och öppnar beställningsformuläret. 4. Användaren klickar på Hämta fil. 5. Formuläret öppnar en dialog som tillåter att användaren kan spara ner filerna på sin hårddisk. 6. Användaren analyserar rapporterna och rättar felen i databasen enligt de instruktioner som finns i sammanställningsfilen (summary.txt).

10 Markus Umefjord UND-07-T (14) 3.3 Formulär Hämta fil När användaren klickar på Hämta fil kommer ovanstående formulär upp. Man kan markera en eller flera filer och spara dessa till sin lokala hårddisk.

11 Markus Umefjord UND-07-T (14) 4 Input och output 4.1 Regelfiler DB03 är beroende av att det finns regelfiler tillgängliga på disken. Regelfilerna fungerar som regler som tolkas av batchprogrammet. Användaren kan välja att aktivera alla regelfiler eller avgränsa körningen till ett mindre antal genom att specificera namnet på en eller flera regelfiler i villkorsformuläret. De regelfiler som finns tillgängliga kan variera över tiden i och med att regler tillkommer eller tas bort Mer information Mer information om regelfilerna hittar du på konsortiewebben ( 4.2 Rapportfiler Varje regelfil med utsökningar(select-satser) som körs kommer att skapa två rapportfiler, en som innehåller primärnyckelns kolumner separarerade av en sträng (separatorn är konfigurerbar standardvärdet är teckenkombinationen tilde, staket, tilde, dvs ~#~) och den andra med SELECT-satser som direkt kan användas för att återfinna de poster som identifierats som felaktiga enligt regeln i regelfilen. Om Antal hittade poster är 0 kommer regelfil med utsökning(select-sats) inte att skapa rapportfiler utan resultatet presenteras endast i sammanställningen. De regelfiler som gör ändringar (UPDATE, INSERT, DELETE) genererar ingen rapportfil utan skriver enbart sitt resultat till Sammanställningen Strängseparerade värden Syftet med att skapa en rapport med strängseparerade värden är att man får ut det felaktiga datat i ett format som kan efterbehandlas manuellt i t.ex. ett program som MS Excel. Exempel: Regelfil: ADRESS.xml Batchkod (deducerad från filnamnet): ADRESS Rapportfilnamn: ADRESS_rapport.txt SQL-sats i regelfilen: SELECT PNR, ADRTYP FROM UTC.ADRESS WHERE GATADR IS NULL; Filinnehåll:

12 Markus Umefjord UND-07-T (14) PNR~#~ADRTYP P658~#~ ~#~ ~#~4 Teckenkombinationen ~#~ används som separator mellan värden i filen. Varje rad avslutas med newline-tecken SELECT-satser Syftet med att skapa ett rapportformat som utgörs av SELECT-satser är att man som användare ska få ett underlag som möjliggör snabb åtkomst/utsökning av de poster som påträffats vid körningen av en regelfil. Poängen är att man på detta sätt enklare ska kunna rätta de fel som upptäckts. De SELECT-satser som skapas kommer att innehålla precis så mycket information som behövs för att entydigt kunna söka ut den post som är felaktig, d.v.s. enbart de kolumner som ingår i primärnyckeln används i WHERE-satsen. Exempel: Regelfil: ADRESS.xml Batchkod (deducerad från filnamnet): ADRESS Rapportfilnamn: ADRESS_rapport.sql SQL-sats i regelfilen: SELECT PNR, ADRTYP, POSTNR FROM UTC.ADRESS WHERE GATADR IS NULL; Filinnehåll: SELECT * FROM UTC.ADRESS WHERE PNR='010101P658' AND ADRTYP='4'; SELECT * FROM UTC.ADRESS WHERE PNR=' ' AND ADRTYP='2'; SELECT * FROM UTC.ADRESS WHERE PNR=' ' AND ADRTYP='4'; Sammanställning Batchen skapar förutom de två rapporterna (utsökningsfiler, SELECT) per regelfil också en sammanställningsfil för hela körningen. Sammanställningen ger en översikt av batchkörningen som helhet och ger indikation om hur lång tid varje regelfil tar att köra, samt hur man ska tolka informationen i rapporterna. Sammanställningen presenteras i alfabetisk ordning där de filer som resulterade i 0 antal hittade poster, presenteras sist. Exempel:

13 Markus Umefjord UND-07-T (14) Regelfiler: KOD123.xml, KOD456.xml Filinnehåll: SAMMANSTÄLLNING AV BATCH DB03 Total exekveringstid: 3456 sek Antal aktiva regelfiler: 2 Starttid: :00:00 Stopptid: :57: LARARE Regelfil: LARARE.xml Namn: Nullvärden i LARARE Beskrivning: Utsökning av lärare där INAKTIV-kolumnen innehåller null eller '_'. Syftet är att... Status: OK Antal hittade poster: 234 Exekveringstid: 1234 sek SQL: SELECT KOD,INST,INAKTIV FROM UTV.LARARE WHERE (INAKTIV IS NULL OR INAKTIV = '_') ADRESS Regelfil: ADRESS.xml Namn: Nullvärden i ADRESS Beskrivning: Utsökning av adresser där GATADR-kolumnen är null. Syftet är... Status: FAIL Primärnyckekolumnen ADRTYP saknas i SELECT-uttrycket. Sqlrapport har ej genererats. Antal hittade poster: 10 Exekveringstid: 2222 sek SQL: SELECT PNR,POSTNR FROM UTC.ADRESS WHERE GATADR IS NULL

14 Markus Umefjord UND-07-T (14)