Kravspecifikation. RB70 - Engångsprogram. Batchhantering. Version 1.0

Transkript

1 Kravspecifikation RB70 - Engångsprogram Batchhantering Webbadress Projektnamn Engångsprogram - Batchhantering Fastställt av Dokumentansvarig Bengt Reinholdsson Dokumentidentitet STU-07-T50 Krav_best Version 1.0 Datum Status

2 Bengt Reinholdsson STU-07-T50 Krav_best 2 (27) Ändringshistorik Revision Datum Av Kommentar Granskare Godkännare Bengt Reinholdsson Första utkast Bengt Reinholdsson

3 Bengt Reinholdsson STU-07-T50 Krav_best 3 (27) Innehållsförteckning 1 INLEDNING SYFTE BESKRIVNING Översikt av RB Delfunktioner BEHÖRIGHET/PREFSTYRNINGAR Behörighet Preferensstyrningar TABELLER Tabeller som läses Tabeller beskrivning FUNKTIONELLA KRAV KRAVLISTA DETALJERAD BESKRIVNING AV KRAVEN FÖR BESTÄLLNINGEN DETALJERAD BESKRIVNING AV KRAVEN FÖR KÖRNINGEN KONTROLLER MEDDELANDEN ICKE FUNKTIONELLA KRAV ANVÄNDBARHET TILLFÖRLITLIGHET PRESTANDA UNDERHÅLLBARHET DESIGN Allmänt om formuläret Ange engångsprogram Ange beställningsvillkor Knappar HJÄLPTEXTER ÖPPNA OCH OBESVARADE FRÅGOR ÖPPNA FRÅGOR BESVARADE FRÅGOR SAMMANFATTNING KRAV FÖRTECKNING... 26

4 Bengt Reinholdsson STU-07-T50 Krav_best 4 (27) 1 Inledning 1.1 Syfte Projektet skall skapa en funktion som ska kunna hantera en- eller flergångsprogram av registervårdskaraktär eller för flyttning av uppgifter från gamla till nya tabeller. 1.2 Beskrivning Så långt möjligt skall den generella batchhanteringen användas, d.v.s. med beställning via en vanlig Nouveaufunktion som startar ett javaprogram vilket i sin tur utför själva operationerna i databasen.

5 Bengt Reinholdsson STU-07-T50 Krav_best 5 (27) Översikt av RB70 Användaren öppnar startformulåret från MENYA00G Nouveau Inställningar GB01A02G Beställning batch RB7000G (GB01A00G) Villkor för batch RB70A01G Databas ANVIP BATINST BATCHJOB BATFIL BATVILL J N Finns batinst post Javaklient DEMON Startar Läser/ uppdatrar Läser RB70_JAVA Engångsprogram (Okänt antal) EB01? EB02? EB03?

6 Bengt Reinholdsson STU-07-T50 Krav_best 6 (27) Delfunktioner Inga delfunktioner finns i funktionen 1.3 Behörighet/prefstyrningar Behörighet Användaren ska vara etablerad i Ladok och ha behörighet till funktionen Preferensstyrningar Funk Nr Vad vill man styra Nyckelord Värde: Resultat Default Typ 1 ) RB70 1 Lägg till/ta bort/ ändra andras beställningar RB70 2 Defaulttid som batchen ska starta 2 ) RB70 3 Bestämmer hur stående beställning ska hanteras i bilden SUPER DEFAULTTID EJSTAENDE J: Visar alla beställningar N: Endast användarens beställningar J: Stående beställning visas ej N: Stående beställning visas N J A S S Figur 1 Behörighet/prefstyrning (Tabell) 1) Typ betyder: S: SYSTPREF, A: ANVPREF, P: PERSPREF 2) Sätts inte DEFAULTTID till något sätts aktuell tid plus en timme som defaultvärde när beställning läggs upp Ändring: 1.4 Tabeller Tabeller som läses Tabeller Läser Uppdaterar ANVIP X BATCHJOB X X BATFIL X BATINST X BATVILL X X

7 Bengt Reinholdsson STU-07-T50 Krav_best 7 (27) Tabeller beskrivning Systemanvändares nätverksadress ANVIP Kolumn Pos Ny Beskrivning Domän ANVKOD 6 * Användarkod SYSTANV EPOSTADR 70 Datorpostadress PCADR 40 Nätadress för ftp PCANV 20 Användaradress för ftp PCDIR 70 Katalog för ftp (ev) PCTKN 8 Teckenkod för ftp 1) PCEXAM 70 Katalog för datafiler för examensbevis 1) Tillåtna värden: MAC=Mac-kod WINDOWS= ISO ISO= ISO ISO8859=ISO PC=MS/DOS DOS=MS/DOS ASCII= "Svensk ASCII, 7 bit"

8 Bengt Reinholdsson STU-07-T50 Krav_best 8 (27) Beställning av batchjobb BATCHJOB Kolumn Pos Ny Beskrivning Domän ANVKOD 6 * Användarkod SYSTANV FUNKTION 7 *S1 Funktionskod RUTIN/NOVFUNK BETECKN 20 * Beställningsbeteckning 1) RADNR 2,0 * Radnummer för beställning 99 2) 4) DATUM 10 Tidigaste körningsdatum ÅÅÅÅ-MM-DD TID 4 Klockslag TTMM FASTJOBB 12 Fritext VILLKOR 1 Villkor finns J/N KORDMARK 1 Markering om att beställning är körd J/P/E/bl 3) SPARAS 1 Spara beställning efter körning J/N KORDDAT 10 Senaste körningsdatum ÅÅÅÅ-MM-DD INSTALLN 1 Inställningar STARTTID 6 Verklig starttid TTMMSS SLUTTID 6 Verklig sluttid TTMMSS 1) Sätts av användaren för att åtskilja versioner av beställningar 2) Sätts maskinellt 3) J=Körning gjord, P=Körning pågår, E=Körning kommer inte att göras 4) Radnummer gäller endast för aktuellt löpnummer och är inte kopplat till någon annan tabell Senaste ändr: Två nya fält: STARTID och SLUTTID. Filer som skapats vid en batchkörning BATFIL Kolumn Pos Ny Beskrivning Domän ANVKOD 6 * Användarkod SYSTANV FUNKTION 7 *S1 Funktionskod RUTIN/NOVFUNK BETECKN 20 * Beställningsnamn FILNR 2,0 * Filnummer 99 1) FILNAMN 100 Filnamn 1) Sätts maskinellt Senaste ändr: Fältet RADNR har ändrats till FILNR och fältet LOPNR har tagits bort

9 Bengt Reinholdsson STU-07-T50 Krav_best 9 (27) Inställningar för batchkörning BATINST Kolumn Pos Ny Beskrivning Domän ANVKOD 6 * Användarkod SYSTANV FUNKTION 7 *S1 Funktionskod RUTIN/NOVFUNK BETECKN 20 * Beställningsnamn INSTNR 2,0 * Inställningnummer 99 1) INSTALLN 100 Inställningsparametrar 1) Sätts maskinellt Senaste ändr: Fältet LOPNR har tagits bort och fältet RADNR har ändrats till INSTNR. Villkor för batchbeställning BATVILL Kolumn Pos Ny Beskrivning Domän ANVKOD 6 * Användarkod SYSTANV FUNKTION 7 *S1 Funktionskod RUTIN/NOVFUNK BETECKN 20 * Beställningsbeteckning 1) VILLNR 2,0 * Villkorsnummer 99 2) VILLKOR 200 Beställningsvillkor 1) Sätts av användaren för att åtskilja versioner av beställningar, t ex av studiemeritförteckningar 2) Sätts maskinellt

10 Bengt Reinholdsson STU-07-T50 Krav_best 10 (27) 2 Funktionella krav 2.1 Kravlista ID Krav Prioritet Länk 1 Funktionen skall kunna hantera en- eller flergångsprogram av registervårdskaraktär eller för flyttning av uppgifter från gamla till nya tabeller. 2 Så långt möjligt skall den generella batchhanteringen användas, d.v.s. med beställning via en vanlig Nouveaufunktion som startar ett javaprogram vilket i sin tur utför själva operationerna i databasen. 3 Engångsbatcharna skall beställas i en gemensam Nouveau-funktion med arbetsnamnet RB70 4 Varje engångsbatch skall ha en egen benämning i serien EB01 och uppåt. Benämningen lagras i fältet VILLKOR i BATVILL 5 Villkorsformulär utvecklas som bygger på det generella villkorsformuläret 6 I villkorsformuläret anger engångsbatchens beteckning och de speciella villkor som eventuellt gäller för den batchen. För att formuläret skall vara så generellt som möjligt anges villkoret i form av textsträng. Öppning och stängning av funktionen Batchbeställning Öppning och stängning av funktionen Öppning och stängning av funktionen Villkor Uppdatering 4 Design 4 Design Program Villkor

11 Bengt Reinholdsson STU-07-T50 Krav_best 11 (27) 2.2 Detaljerad beskrivning av kraven för beställningen Batchbeställning Under detta krav finns alla krav som tillhör funktionalitet som finns i Nouveau. Generellt gäller att batchfunktionen GB01 ska användas för inläggning av batchbeställning. - Beställningsformuläret ska vara GB01A00G. Detta formulär finns redan och specificeras därför inte i detta projekt. - Funktionen saknar delfunktioner och därför startar det generella beställningsformuläret i GB01 när man väljer funktionen. Menyalternativ i RB70 I RB70ska de generella menyalternativen fungera som i övriga Ladok.

12 Bengt Reinholdsson STU-07-T50 Krav_best 12 (27) Öppning och stängning av funktionen Öppning Funktionen RB70 ska ligga under funktionsgrupp Registervård. Funktionen ska öppna det generella batchbeställningsformuläret GB01A00G. Inga speciella system- eller andra preferenser är nödvändiga än de som sätts som standard, se Preferensstyrningar Kontrollera att om körstatus (se 2.4 kontroller) Stängning När funktionen avslutas ska det göras enligt S&G. Det vill säga när stängning av formulären görs kontrolleras om någon inläggning/ändring gjorts utan uppdatering, i så fall ska meddelande/dialogruta visas enligt S&G. Uppdatering Godkänt Uppdatera BATCHJOB och BATVILL Uppdatering: BATVILL: Ny post skapas (första tre fälten hämtas från BATCHJOB) ANVKOD=Användarkod FUNKTION=funktion BETECKN= beteckning Nytt VILLNR för varje villkor VILLNR= n fältet VILLKOR PROGR=[EBnn] [funktionsspecifikt]= [funktionsspecifikt] BATCHJOB: Om inte fältet VILLKOR är lika med J för aktuell batchbeställning skall fältet uppdateras med ett J

13 Bengt Reinholdsson STU-07-T50 Krav_best 13 (27) Efter uppdatering ska det läggas ut ett meddelande på hur uppdatering gick. Om uppdatering gick bra - ADM_001- Uppdatering klar Annars - ADM_002 Ingen ändring gjord 2.3 Detaljerad beskrivning av kraven för körningen Start av batch Kontrollera att det finns villkor i tabellen BATVILL. Om det saknas ska inte batchen starta. Mail ska skickas med status AVBRUTEN och beställning sätts till A i BATCHJOB - Kontrollera i tabellen BATCHJOB om det finns någon batch att starta där datum är samma och tiden är mindre eller lika med aktuell tid och där körstatus är tomt. - Kontrollera att om körstatus KODMARK i tabellen BATCHJOB på aktuell post inte är J= Körning gjord eller P= Körning pågår, innan batchen startar. Om fel ska batchen sättas till avbruten Start av engångsprogram Eftersom RB70 inte har egen java program måste startscriptet kontrollera vilket ingångsprogram som ska startas i stället. Detta görs genom att läsa posterna på beställningen i tabellen BATVILL. I beställningen måste det finnas följande i BATVILL.VILLKOR= PROGR=[EBnn] Finns det PROG=[engångsprogram EB??]i villkorsfältet ska detta program starta. o Vid starten av engångsprogrammet ska övriga eventuella villkor vara tillgängligt för engångsprogrammet. o På vilket sätt dessa program fungera hanteras inte i denna spec. annars ska batchen inte starta. Mail ska skickas med status AVBRUTEN och beställning sätts till A i BATCHJOB

14 Bengt Reinholdsson STU-07-T50 Krav_best 14 (27) Avbrott i batchkörning Om något inte fungerar i samband med körningen av batchen skall programmet avslutas och Mail ska skickas med status AVBRUTEN och beställning sätts till A i BATCHJOB E-postmeddelande Utseende på mailet ska vara som nedan E-postmeddelande skickas till den eller de adresser som angivits i BATINST. Om ingen e-post adress angivits i BATINST ska e-post adressen hämtas från ANVIP.EPOSTADR för användaren som lagt upp batchbeställningen. Skulle e-post adress saknas i ovanstående tabell kan inget mail skickas. Generellt gäller följande: FROM: mail adress, hämtas från properties filen. SENT: Dag, månad år samt tid hämtas från serverklockan TO: Mottagaren hämtas från BATVILL i förstahand och i andra hand ANVIP SUBJECT: Inleds med [BATCH] för enklare sortering och därefter: o Funktionsbeteckning med funktionsnamnet. Beteckning finns i BATCHJOB men bara de första fyra ska användas. Namnet hämtas från NOVFUNK där slagningen sker med hela BATCHJOB.FUNKTION o Batchbeteckningen hämtas från BATCHJOB.BETECKN o Status ska informera hur körningen gått t ex KLAR eller avbrutits I mailet ska det också framgå när batchen startade och avslutades

15 Bengt Reinholdsson STU-07-T50 Krav_best 15 (27) E-POST RB70 Utkast From: [Mailadress] [mailto:[mailadress]] Sent: den [Dag] [månad][åååå] TT:MM To: [Mottagare] Subject: [BATCH][Funktion (del)funktionsnamn], [batch beteckning],[status] Detta är ett automatgenererat meddelande som du inte kan svara på. Körningen blev [Status] Körningen påbörjades TT:MM och avslutades TT:MM Följande var med i beställningen: Körd engångsprogram: [program] [Villkor i beställningen] [specifikt för varje engångsprogram] Efter avslutad körning Utkast Efter avslutad körning (dvs allt har fungerat) skall: tabellen BATCHJOB uppdateras: o KORDMARK = J o STARTID = [tiden som batchen verkligen startade (TTMMSS)] o SLUTTID = [tiden som batchen verkligen avslutades (TTMMSS)] e-postmeddelande skickas till den eller de adresser som angivits i BATINST. o Om ingen e-post adress angivits i BATINST ska e-post adressen hämtas från ANVIP.EPOSTADR för användaren som lagt upp batchbeställningen. Skulle e-post adress saknas i ovanstående tabell kan inget mail skickas. Resultatfil: Eventuella resultatfiler ska sparas på server och filnamnen ska sparas i tabellen BATFIL

16 Bengt Reinholdsson STU-07-T50 Krav_best 16 (27) 2.4 Kontroller Kontroll körstatus Godkänt Kontrollera att om körstatus: - om status är lika med "Pågår" ska alla fält i villkorsformuläret dimmas och meddelande ADM_210 Körningen har ändrats till PÅGÅR, uppdatering är inte tillåtet - om status är lika med "Klar" ska alla fält i villkorsformuläret dimmas och meddelande ADM_211 Körningen har ändrats till KLAR, uppdatering är inte tillåtet 2.5 Meddelanden ADM_001 Uppdatering klar Uppdatering ADM_002 Ingen ändring gjord Uppdatering ADM_210 Körningen har ändrats till PÅGÅR, uppdatering är inte tillåtet ADM_211 Körningen har ändrats till KLAR, uppdatering är inte tillåtet RB70_001 Programmet börjar inte med EB. Program RB70_002 Villkoret är ologiskt, det saknas =. Villkor RB70_003 Det måste finnas värden före och efter = Villkor Kontroll körstatus Kontroll körstatus

17 Bengt Reinholdsson STU-07-T50 Krav_best 17 (27) 3 Icke funktionella krav 3.1 Användbarhet Designstandard Utkast All utveckling av program med grafiskt layout, det vill säga formulär och utskrifter, ska följa Standard & Guidelines (S&G) version 8.02 som gäller för Uniface - utveckling. 3.2 Tillförlitlighet Hur ofta ett fel får uppstå under viss tidsperiod. 3.3 Prestanda Eventuella svarstider på en transaktion i x antal fall 3.4 Underhållbarhet Programmerings standard Utkast De delar som utvecklas i Uniface ska följa programmeringsstandarden som gäller för verktyget. Utvecklaren ska kommentera koden på sådant sätt att det är lätt att förstå vad som händer i programmet. Avgränsningar Utkast Ej prioriterat Ändringar som kan beröra andra funktioner eller rutiner inom Studiedokumentation ska inte göras inom ramen av projektet.

18 Bengt Reinholdsson STU-07-T50 Krav_best 18 (27) Anpassningar i andra funktioner Utkast Ej prioriterat Inga andra anpassningar i andra funktioner är nödvändiga. Testning Utkast Ej prioriterat Alla testfall ska sparas i Quality Center och efter leverans ska dessa vara tillgängliga för underhållet.

19 Bengt Reinholdsson STU-07-T50 Krav_best 19 (27) 4 Design Allmänt om utsökning av data 1. Välj ett engångsprogram som ska starta 2. Finns det ett eller flera villkor för engångsprogrammat kan man ange dem här: a. Villkoret byggs upp enligt [styrparameter]=[värde] b. Genom knappen NY kan fler villkor läggas in. c. Genom knappen stryk kan en markerad rad strykas. 3. Uppdatera villkoren i batchbeställningen. 4. Batchen startar vid angiven tidpunkt och läser ut posterna Allmänt om formuläret Formulär: Godkänt

20 Bengt Reinholdsson STU-07-T50 Krav_best 20 (27) Formuläret byggs upp i fyra delar: Del 1 Beställning: Visar aktuell batch, innehåller visningsfält över den batchbeställning som villkoren kommer att tillhöra (Beteckning, datum, tid, användare, körstatus, sparas) Del 2 Ange engångsprogram: Fältet Program är obligatoriskt och ska innehålla vilket engångsprogram som ska köras. Programmet måste börja med EB[löpnr]+ [ev mer]. Programnamnet får ej överstiga 45 tecken. Del 3 Ange beställningsvillkor: Det sak gå att lägga in en eller flera villkor. Fältet villkor tillåter max 50 tecken och att det ska finnas ett = tecken i villkoret samt att det ska finnas tecken på båda sidor om detta = tecken. Det finns dessutom två knappar, en för att lägga till ett villkor och en för att stryka markerad villkor. Del 4 Knapp uppdatera: Knappen uppdaterar BATVILL och BATCHJOB Formuläret öppnas Godkänt Ingående parametrar i funktionen är: användare, funktion, beteckning. Dessa används sedan för att slå i tabellen BATCHJOB för att fylla på fälten i visningsfälten. Om ett: Alla fält är blanka och valbara. Befintlig beställning läses upp ska villkoren läsas upp enligt beställningen.

21 Bengt Reinholdsson STU-07-T50 Krav_best 21 (27) Fönsterlist Godkänt I fönsterlisten ska stå: RB70 - [Villkor för engångsprogram] : Ändrat rubrik Funktionsmeny Godkänt Meny: Knapp Kortkommando Beskrivning Funktion Ny Ny CTRL+INS Lägger till nytt villkor Stryk Stryk CTRL+DEL Ta bort ett markerat villkor Uppdatera Uppdatera CTRL+U Uppdatera databasen Tabbordning Godkänt Tabbordning: Framåt : Program, villkor, ny, stryk, knapp Uppdatera, program Bakåt: knapp Uppdatera, stryk, ny, villkor, Program, knapp Uppdatera.

22 Bengt Reinholdsson STU-07-T50 Krav_best 22 (27) Ange engångsprogram Fält: Program Utkast Typ: Editbox Ledtext: Program Obligatoriskt: Ja Längd: 55 Hjälptext: Ange ett engångsprogram. Programnamnet ska börja med EB max 45 tecken Defaultvärde: Blankt Sökknapp: Nej Sökmönster: Nej Villkor: Blåmålning av felaktigt värde, markören kvar i fältet vid: 1. Första två tecken måste börja med EB. Felmeddelande: Vid felaktig inmatning eller dylikt: 1. RB70_001 Programmet börjar inte med EB. Kommentar: Ange beställningsvillkor Fält: Villkor Utkast Typ: Editbox Ledtext: inget Obligatoriskt: Nej Längd: 73 Hjälptext: Villkor för beställningen max 50 tecken. Defaultvärde: Blankt Sökknapp: Nej Sökmönster: Nej Villkor: Blåmålning av felaktigt värde, markören kvar i fältet vid: 1. Det måste finnas ett = på raden 2. Det måste finnas värden på båda sidorna av =.

23 Bengt Reinholdsson STU-07-T50 Krav_best 23 (27) Felmeddelande: Kommentar: Vid felaktig inmatning eller dylikt: 1. RB70_002 Villkoret är ologiskt, det saknas =. 2. RB70_003 Det måste finnas värden före och efter =. Knapp Ny Ledtext Ny Karaktär Boilerplate Obligatorisk Nej Hjälptext (F1) Skapa ny post. Längd Enligt S&G Defaultmarkerad Nej Villkor: - Knappen lägger till ny rad för villkoren - Ingen ändring i databasen görs i detta läge Knapp Stryk Ledtext Stryk Karaktär Boilerplate Obligatorisk Nej Hjälptext (F1) Stryk markerad post. Längd Enligt S&G Defaultmarkerad Nej Villkor: - Knappen stryker markerad villkor. - Ingen ändring i databasen görs i detta läge

24 Bengt Reinholdsson STU-07-T50 Krav_best 24 (27) Knappar Knapp Uppdatera Ledtext Uppdatera Karaktär Boilerplate Obligatorisk Ja Hjälptext (F1) Lagrar val i databasen Längd Enligt S&G Defaultmarkerad Nej Villkor: - Knappen skall alltid vara valbar under förutsättning att körstatus inte är "Klar" eller "Pågår". - Alla obligatoriska fält och andra villkor måste vara uppfylda. - Knappen byter namn till "OK" om körning är "Pågår" eller "Klar". Vid aktivering: - Kontrollera att alla obligatoriska fält är korrekt ifyllda. Om kontrollen hittar felaktighet ska markören ställa sig på aktuellt fält och blåmarkera eventuella data Se övrigt Uppdatering.

25 Bengt Reinholdsson STU-07-T50 Krav_best 25 (27) 5 Hjälptexter Villkorsformulär RB70A01G RB70 Villkorsformulär för engångsbatchar Senast uppdaterad Allmänt I detta formulär anger du engångsprogrammet samt eventuella styrparametrar. Villkor för beställningen av filen till SCB måste läggas in (uppdateras) för att körningen ska kunna starta. Ange engångsprogram Ange namnet på engångsprogrammet. Observera att filnamnet ska alltid börja med EB. Namnet för inte vara längre än 44 tecken långt Ange beställningsvillkor Du kan lägga till och ta bort villkor via kommandona "Ny" och "Stryk" och för att spara ändringar aktiverar du "Uppdatera". 6 Öppna och obesvarade frågor 6.1 Öppna frågor 6.2 Besvarade frågor

26 Bengt Reinholdsson STU-07-T50 Krav_best 26 (27) 7 Sammanfattning krav 7.1 Förteckning BATCHBESTÄLLNING MENYALTERNATIV I RB ÖPPNING OCH STÄNGNING AV FUNKTIONEN UPPDATERING START AV BATCH START AV ENGÅNGSPROGRAM AVBROTT I BATCHKÖRNING E-POSTMEDDELANDE E-POST RB EFTER AVSLUTAD KÖRNING KONTROLL KÖRSTATUS DESIGNSTANDARD PROGRAMMERINGS STANDARD AVGRÄNSNINGAR ANPASSNINGAR I ANDRA FUNKTIONER TESTNING FORMULÄR: FORMULÄRET ÖPPNAS FÖNSTERLIST FUNKTIONSMENY TABBORDNING FÄLT: PROGRAM FÄLT: VILLKOR KNAPP NY... 23

27 Bengt Reinholdsson STU-07-T50 Krav_best 27 (27) KNAPP STRYK KNAPP UPPDATERA... 24