AP221 Use Case TUL Definer tjeneste

Transkript

1 AP221 Use Case TUL Definer tjeneste

2 Definer tjeneste Definere tjeneste består av registrering av metadata, altså informasjon om tjenesten. Tjenestetype velges dersom den ikke allerede er valgt. Metadata som skal settes er enten generelle (tjenestenivå) eller tjenestetypespesifikke (utgavenivå). Noe metadata er enkeltinformasjon, mens andre skal parametriseres ytterligere. Med enkeltinformasjon menes informasjon som angis direkte, uten ytteligere parametrisering. Ytterligere parametrisering gjøres bl.a. i under-use casene Spesifiser arbeidsflyt, og Spesifiser skjemasett. Disse gjelder kun for innsendingstjeneste. Definering av tjeneste og utvikling av tjenesteinnhold er aktiviteter som går om hverandre. En tjenesteutvikler kan lage skjema i InfoPath før han definere tjenesteparametre, eller han kan sette parametre først. Alt som ikke er direkte avhengig av hverandre kan gjøres i vilkårlig rekkefølge. Definering av feltparametre, sporvalg og sideparametre er avhengig av at det finnes et InfoPathskjema og kan dermed først gjøres etter at InfoPaht-skjemaet er utviklet. Se Tabell 1 for hva som kan defineres. For meldingsjenester vil hensiktsmessige parametre settes i TUL og resten settes i i selve meldings- MLen fra etat. Hvilke parametre som kommer i TUL og hvilke som kommer i MLen avgjøres i design. Generelt er det at parametre som gjelder for meldingstypen settes i TUL, mens parametre som varierer fra melding til melding (eks. innhold) vil settes i MLen. Spesifisere arbeidsflyt: Valg av arbeidsflytmal og parametrisering av valgt arbeidsflyt. Hvert av stegene i en arbeidsflyt har spesifikke parametre, som for eksempel tekst og rollekrav. Spesifisere skjemasett: Valg av hvilke skjema som skal være del av et skjemasett og parametrisering av disse. Et skjemasett er en logisk mapping mellom hvilke skjemaer som kan inngå som vedleggsskjemaer til den aktuelle utgaven av tjenesten. Et skjema kan inngå i flere skjemasett. Hovedskjema og Vedleggsskjema er dermed metadata som settes pr skjema i definisjonen av skjemasett (innsendingstjenester), og ikke en egenskap ved selve skjemaet. Hovedskjemaet i skjemasettet vil være det skjemaet som hører til den valgte utgaven. Definering av formidlingstjenester vil foregå ved bruk av Microsoft BizTalk som vil være tilgjengelig på Citrix arbeidsflaten for tjenesteutviklingsløsningen. Følgende aktiviteter kan utføres: Definere tjenesten, inkludert bruk av autentisering, autorisering og signering Spesifisere utgående kanaler Routing - definere at data eller deler av data (splitting av data) kan sendes til en eller flere tjenester hos en eller flere tjenesteeiere. Konfigurering av oversendelsesmetoder eks. web service, FTP Logging av dokumenter før og etter transformasjonen Formidlingstjenester vil ikke beskrives ytterligere i use caset. 2

3 Fagperson Definer parametre Er tjenestetype valgt? Ja Velg metadata som skal registreres Nei Velg tjenestetype Definer tjenesteparametre Definer utgaveparametre TUL Opprett utgave og arbeidsflate Lagre tjenesteparametre Lagre utgaveparametre Vis inputfelt for metadata Figur 1 - Definer tjeneste, overordnet flyt. Aktør(er) Trigger Pre-betingelser Post-betingelser Normal utføring Definer tjeneste Fagperson Bruker oppretter tjeneste og/eller utgave og kommer inn på arbeidsflaten for tjenesten/utgaven Bruker finner eksisterende tjeneste, velger denne og kommer inn på arbeidsflaten Tjeneste er opprettet (use case Opprett tjeneste og tjenesteutgave ) Bruker er innlogget på tjenesteutviklingsløsningen (use case Logg inn ) Tjenesten som skal defineres er valgt i tjenesteuviklingsløsningen (use case Finn tjeneste ). Tjenestetype er valgt, og kan ikke endres Valgte metadata er konfigurert. Se Figur 1 - Definer tjeneste, overordnet flyt. 1. Bruker velger å definere parametre; ved å velge tjenestespesifikasjon på arbeidsflaten 2. Er tjenestetype valgt? a. Tjenestetype valgt: Arbeidsflaten for tjenesteutgaven er allerede tilgjengelig, gå til punkt 4 b. Tjenestetype ikke valgt: Velg tjenestetype fra liste (Innsendingstjeneste, meldingstjeneste, formidlingstjeneste) 3. Utgave og arbeidsflate opprettes. Arbeidsflaten vises 4. Inputfelt for metadata vises: Tjenestespesifisering 5. Velg metadata som skal registreres: Se tabell 1 for eksempler på parametre dette er ikke en uttømmende liste. a. Tjenesteparametre (felles for alle utgaver av en tjeneste). 3

4 Definer tjeneste Tjenesteparametre lagres b. Utgaveparametre (spesifikke for tjenestetypen og utgaven). Spesielt for tjenestetypene er: Meldingstjeneste * Utgaveparametre * Oversendelsesparametre Innsendingstjeneste * Utgaveparametre * Arbeidsflyt (se eget under-use case Spesifiser arbeidsflyt) * Skjemasett (se eget under-use case Spesifiser skjemasett) Utgaveparametre lagres Alternativ utføring Feilhåndtering Forretningsregler Use case referanser Det vil være en løs kobling mellom sidene og feltene i InfoPathdokumentet og de parameterne som er koblet til dem. Det betyr at definerte parametere kan bevares, selv om InfoPath-dokumentet slettes eller oppdateres. Det er mulig å synliggjøre om definerte parametere mangler kobling til felt eller side i InfoPath-dokumentet. Hvordan dette synliggjøres, og om det i det hele tatt skal gjøres, vil være noe som må avgjøres i design. Det må defineres hva som skal gjøres dersom to brukere forsøker å oppdatere på den samme siden for feltparametre Tjenesteutvikler skal kunne registrere alle relevante parametre om tjenesten. Defineringen trenger ikke gjøres ferdig i én omgang, men tjenesteutvikler skal kunne gå til andre deler av tjenesteutviklingen og returnere til definisjonen på et hvilket som helst tidspunkt. Opprettet tjeneste og tjenesteutgave o AP221 Use Case - TUL Opprett tjeneste og tjenesteutgave.doc Logge inn o AP221 Use Case - TUL Logg inn.doc Finne Tjeneste o AP221 Use Case - TUL Finn Utarbeid arbeidsflyt o AP221 Use Case - TUL Utarbeid arbeidsflyt.doc Spesifiser arbeidsflyt o I dette dokumentet Spesifiser skjemasett o I dette dokumentet Referanse til krav TUL_ TUL_ TUL_ TUL_ Alle nye tjenester kan defineres av tjenesteeier i tjenesteutviklingsløsningen. Det må minimum være mulig å registrere egenskapene i tabell 1. Tabell 1 refererer til tabell i U_Bilag_1_Kravspesifikasjon_Tjenesteutvikling.doc For alle tjenester er det mulig å aktivere logging av sporingsinformasjon knyttet til skjema/data. Det er ikke nødvendig å angi alle disse egenskapene (se tabell 3) før utvikling begynner. Det betyr blant annet at det er mulig å gjøre layout og definere tekster før det er angitt om innsendingstjenesten krever signering. Tabell 3 refererer til tabell i 4

5 Definer tjeneste U_Bilag_1_Kravspesifikasjon_Tjenesteutvikling.doc TUL_ Det skal minimum være mulig å angi egenskapene i tabell 3. TUL_ TUL_ SBLE_ SBLE_ SBLE_ SBLE_ TUL_ TUL_ TUL_ TUL_ TUL_ TUL_ TUL_ TUL_ Tabell 3 refererer til tabell i U_Bilag_1_Kravspesifikasjon_Tjenesteutvikling.doc Det kan angis om sluttbruker skal ha styrt eller fri navigering, dvs. om sluttbruker kun kan benytte neste/forrige side eller kan velge fritt. Det er viktig at det som legges inn første gang man definerer en innsendingstjeneste enkelt kan endres i etterkant. I dette ligger det også at det er enkelt å produksjonssette endringer i definisjonen. Presentasjonsfelter benyttes i forbindelse med en innsendingstjeneste og vises som en del av tjenesteinstansnavnet i lister for å kunne skille ulike instanser av samme tjeneste. Presentasjonsfelter skal kunne benyttes for alle tjenester som har instansdata presentasjonsfeltene kan populeres fra. Med instansdata menes data som er dynamiske, eksempelvis skjemainnhold fra bruker og data fra innsynstjeneste. For statiske tjenester, eksempelvis meldinger, defineres titler o.a. i de statiske dataene, og presentasjonsfelter benyttes derfor ikke for disse. De identifiserende feltene som defineres kan være forskjellig fra presentasjonsfeltene som defineres for tjenesten. Presentasjonsfelter benyttes i forbindelse med en innsendingstjeneste og vises som en del av tjenesteinstansnavnet i lister for å kunne skille ulike instanser av samme tjeneste. Presentasjonsfelter skal kunne benyttes for alle tjenester som har instansdata presentasjonsfeltene kan populeres fra. Med instansdata menes data som er dynamiske, eksempelvis skjemainnhold fra bruker og data fra innsynstjeneste. For statiske tjenester, eksempelvis meldinger, defineres titler o.a. i de statiske dataene, og presentasjonsfelter benyttes derfor ikke for disse. De identifiserende feltene som defineres kan være forskjellig fra presentasjonsfeltene som defineres for tjenesten. Dagens funksjonalitet for å angi betalingsinformasjon i tjenesteutviklingsløsningen finnes også i ny løsning Det er mulig å angi at betalingsinformasjon skal genereres basert på innhold i en tjeneste i Altinn. Det er kun preutfylling på feltnivå som skal angis i tjenesteutviklingsløsningen. Det må være mulig å angi identifiserende felter (benyttes blant annet ved preutfylling på meldingsnivå) i tjenesteutviklingsløsningen. Tjenesteutviklingsløsningen har et grensesnitt der sporvalg kan defineres Det kan angis om sluttbruker skal ha styrt eller fri navigering, dvs. om sluttbruker kun kan benytte neste/forrige side eller kan velge fritt. Det er også mulig å definere andre svaravhengige spørsmål enn de som er definert i ML Schema meldingsspesifikasjonen. Det er mulig å definere felter som svaravhengige spørsmål eller kunne legge til svaravhengige spørsmål utover de feltene som er i ML Schema meldingsspesifikasjonen. 5

6 Krav dekket i design TUL_ TUL_ Meldingstjenester TUL_ TUL_ TUL_ TUL_ TUL_ TUL_ TUL_ TUL_ Definer tjeneste Det er mulig å angi hvilke felter som skal påvirkes av svarene sluttbruker oppgir. Det kan være opplysninger som bruker oppgir i en del av en innsendingstjeneste som bestemmer hvilke opplysninger brukeren skal fylle ut videre. Slike opplysninger kan defineres som sporvalgsfelter. Det er mulig å angi oversendelsesmåte til online eller batch for meldinger fra tjenesteeiere. For batch er det mulig å angi periode, dvs. i hvilken tidsperiode (datoer) batchen skal hentes. For batch er det mulig å angi hentefrekvens, dvs. hvor ofte (hver onsdag, hvert døgn, hver time, etc.) batchen skal hentes. For batch er det mulig å angi hentemetode, dvs. hvilken protokoll (ftp, sftp, http, etc.) som skal benyttes for overføring av batch. For batch er det mulig å angi kjørenummer. For batch er det mulig å angi sende kvittering/jobbkort ved henting av batch. For oversendelser av meldinger er det mulig å angi autentiseringsinformasjon. Det er mulig å angi at tjenesteeier skal kunne motta bekreftelse på at en melding er mottatt og lest. Tabell 1 med parametre er ikke uttømmende. Detaljering må gjøres i design. Autentiseringsinformasjon for meldingstjeneste bør gjøres ulesbart da dette kan være sensitiv informasjon. Hvordan dette gjøres betemmes i design. TUL_ TUL_ TUL_ TUL_ SBLE_ Det er mulig å sette opp en meldingstjeneste med forskjellige egenskaper i forskjellige sluttbrukermiljøer. For eksempel skal det være mulig i systemtestmiljøet å sette opp tjenesten til å hente meldinger fra en maskin hos tjenesteeier, mens det i akseptansetest kan benyttes en annen maskin. For noen tjenester kan det være behov for spesielle kontroller ved åpning av tjenesten, ekstra behov for preutfylling, spesielle registeroppslag under utfylling, kontroller ved lagring og innsending med mer. Dette vil i hovedsak gjelde for innsendingstjenester, men tjenesteutviklingsløsningen må legge til rette for at tjenesteutvikler kan angi at slik funksjonalitet også kan benyttes av andre tjenestetyper. Ett skjemasett kan være definert som én stor ML Schema meldingsspesifikasjon i OR, SERES eller en annen metadatakilde, eller alle skjema i ett skjemasett kan være definerte som separate meldingsspesifikasjoner. Dersom alle skjema i ett skjemasett er definerte som separate ML Schema meldingsspesifikasjoner i OR, SERES eller annen metadatakilde er det mulig å definere hvilke skjemaer som inngår i et skjemasett. Det kan maks defineres 6 presentasjonsfelter for en tjeneste 6

7 Tabell 1 Parametre som kan settes i tjenestedefinering. UP=Utgaveparameter, TP=Tjenesteparameter. Parameter TP UP Innsendingstjeneste UP Formidlingstjeneste UP Meldingstjeneste Tjenestens id (Settes automatisk) Type tjeneste Tjenestens interne navn Tjenesteeier(e) (Settes automatisk) Tjenestenavn Tjenestens kortnavn Tjenestenummer Beskrivelse av tjenesten Sporing og logging Beskrivelse Gyldig fra (dato) Gyldig til (dato) Navn i sluttbrukerløsning Intern beskrivelse Hvem som skal kunne bruke tjenesten Språkstøtte (hvilke språk skal støttes) Hovedspråk Skal man kunne legge ved binære filvedlegg Kryptere binære filer (hvis den over er avsjekket) Egenskaper ved visning i portalen Lagres i Arkiv/meldingsboks Instansier arkiv Oversendelsesmåte (Batch vs Online) Batchparameter Hentefrekvens Batchparameter Henteperiode Batchparameter Hentemetode Batchparameter Batchkvittering Batchparameter Kjørenummer Autentiseringsinformasjon Angi om avsender skal ha lesebekreftelse Miljøspesifikke egentskaper Kildedata (webservice) Arbeidsflyt (eget under-use case) Skjemasett (eget under-use case) Skjemasett kan skjema i skjemasett fylles ut én eller flere ganger Utskriftsversjon (velg fra produserte views i InfoPath, må gjøres etter definering av view) Kvitteringsside (velg fra produserte views i InfoPath, må gjøres etter definering av view) Sporvalg (velg fra definerte felt, må gjøres etter skjemautvikling) Sideparametre sidenavn, sidetype (må gjøres etter skjemautvikling) Feltparametre hjelpetekster, betalingsiformasjon og presenterende felter (må gjøres etter skjemautvikling) Styrt eller fri navigering 7

8 Parameter TP UP Innsendingstjeneste Bruk av ELMER2 (defaultverdi, kan velges bort) UP Formidlingstjeneste UP Meldingstjeneste Spesifiser arbeidsflyt Spesifisering av arbeidsflyt må gjøres for innsendingstjenester. Ved definering av utgave velges det fra en liste av tilgjengelige arbeidsflytmaler, enten generelle arbeidsflytmaler eller ferdigspesifiserte maler (spesifisert for aktuell tjenesteeier). Disse arbeidsflytmalene har et sett av parametre som må fylles ut, i tillegg kan det også legges til kontroller på steg hvor dette er definert i malen. Fagperson Velg arbeidsflytmal Velg arbeidsflytsteg som skal defineres Velg utfyllingssteg Velg signeringssteg Velg arkivering/kvittering Velg kontroll Velg annet steg TUL Lagre steg og parametre Vis arbeidsflytdefinering Figur 2 - Spesifiser arbeidsflyt Aktør(er) Trigger Pre-betingelser Post-betingelser Normal utføring Definer tjeneste Spesifiser arbeidsflyt Fagperson Bruker velger å spesifisere arbeidsflyt Tjeneste er opprettet (use case Opprett tjeneste ) Bruker er innlogget på tjenesteutviklingsløsningen (use case Logg inn ) Bruker har navigert til riktig tjeneste og utgave (Se use case Finn tjeneste og utgave ) og valgt denne. Bruker står på arbeidsflate for utgaven. Arbeidsflytmal som skal velges må være ferdig utarbeidet og tilgjengeliggjort i TUL (se use case Utarbeid arbeidsflytmal og kompontenter, og Bygg verktøykasse ) Arbeidsflyt er spesifisert Se Figur 2 - Spesifiser arbeidsflyt 1. Vis arbeidsflytdefinering: Bruker kan velge arbeidsflytmal blant tilgjengelige maler. 2. Velg arbeidsflytmal: Bruker velger arbeidsflytmal fra liste. Listen inneholder både generelle arbeidsflytmaler og spesifiserte maler med defaultverdier (definert for aktuell tjenesteeier) 8

9 Definer tjeneste Spesifiser arbeidsflyt 3. Velg arbeidsflytsteg som skal defineres: Dette er eksempler på steg, ikke uttømmende liste. Stegene har flere parametre som skal defineres, eksempler vises under. a. Utfyllingssteg i. Definer rollekrav b. Signeringssteg i. Definer rollekrav (innebærer å angi sikkerhetsnivå og rettigheter man stiller til signerer i sluttbrukerløsningen) ii. Velg signeringstekst c. Definer arkivering/kvittering i. Definer rollekrav ii. Velg kvitteringstekst d. Legg til kontroll: Velg blant tilgjengelige kontroller. Dette kan for eksempel være avansert logikk som ikke kan lages i InfoPath-visningen eller det kan være oppstartkriterier for et steg, eksempel myndighetssjekk. (Se use case Bygg verktøykasse ). e. Annet steg: Listen ikke uttømmende, det kan også være andre steg som er definert 4. Lagre steg og parametre. Feilhåndtering Forretningsregler. Referanse til TUL_ Det er mulig å angi at ulike roller skal signere på ulike krav deler av skjemaet, skjemasettet eller filvedlegg/ene. Krav dekket i design TUL_ TUL_ TUL_ INT_ TUL_ Det kan angis hvorvidt en signering er obligatorisk. Det er mulig å angi sikkerhetskrav til hvert signeringstrinn, det vil si hvilket sikkerhetsnivå og rettigheter man stiller til en bruker som skal signere i sluttbrukerløsningen. Under definering av tjeneste kan man opprette ny arbeidsflyt eller gjenbruke en eksisterende. Et skjema kan inngå i en arbeidsflyt. En arbeidsflyt kan ha parallelle signeringssteg. 9

10 Spesifiser skjemasett Alle skjema som skal inngå i et skjemasett må være definert som egne tjenester i tjenesteutviklingsløsningen. Dette kan være tjenester som ikke består av annet enn et skjema. Følgende må eksistere for tjenesten for å kunne benytte den som et vedleggsskjema: - Nødvendige metadata (f.eks. navn og beskrivelse) - InfoPath dokument - Evt. navigasjon - Sideegenskaper - Feltegenskaper Når et skjemasett defineres opp, vil det være enkelte parametere i vedleggsskjemaene som overstyres av hovedskjemaet. Blant annet gjelder dette arbeidsflyt. Arbeidsflytdefinisjonen som gjelder for hovedskjemaet vil også gjelde for vedleggsskjemaene. Felt og verdier i vedleggsskjemaene vil være tilgjengelig i alle skjemaene i skjemasettet som følger prosedyren under inkludert hovedskjemaet. Verdien kan ikke endres, men kan brukes for oppslag og beregninger. Dette gjøres ved at man i tillegg til å importere en SD i InfoPath for meldingsbeskrivelsen benytter seg av en skjemasett-sd 1. Import gjøres via wizards på samme måte som for meldingsbeskrivelsen. Skjemasett-SDen må importeres i hvert skjema i skjemasettet som trenger tilgang til felter i andre skjemaer. Dersom det gjøres endringer på et av skjemaene i skjemasettet, må skjemasett-sden oppdateres på nytt i skjemasettet. Fagperson Velg skjemasettelement Velg vedleggskjema Velg om binært filvedlegg er tillatt TUL Vis skjemasettdefinering Lagre parametre Generer skjemasett-xsd Figur 3 - Spesifiser skjemasett 1 Secondary data source i InfoPath 10

11 Aktør(er) Trigger Pre-betingelser Post-betingelser Normal utføring Definer tjeneste Spesifiser skjemasett Fagperson Tjenesteutviklingsløsning (TUL) Bruker velger å spesifisere skjemasett Tjeneste er opprettet (use case Opprett tjeneste ) Bruker er innlogget på tjenesteutviklingsløsningen (use case Logg inn ) Bruker har navigert til riktig tjeneste og utgave (Se use case Finn tjeneste og utgave ) og valgt denne. Bruker står på arbeidsflate for utgaven. Skjema som skal være del av et skjemasett må være ferdig utviklet og migrert til sluttbrukerløsningen Skjemasett er spesifisert Se Figur 3 - Spesifiser skjemasett 1. Skjemasett-definering vises: Inputfelt for skjemasettdefinering 2. Velg skjemasettelement: Liste med tilgjengelige vedleggsskjema vises. Listen består av allerede opprettede skjema (som er del av en tjeneste) 3. Lagre parametre. Det angis også her om det i sluttbrukerløsningen skal være mulig å fylle ut kun én eller flere instanser av samme skjema i skjemasettet. 4. Generer skjemasett-xsd: Ved ferdig skjemasett-definering genereres det opp en skjemasett-xsd. Alternativ utføring Feilhåndtering Forretningsregler Referanse til krav Krav dekket i design Bruker skal sette sammen et skjemasett hvor ett skjema velges som hovedskjema og det kan være flere vedleggskjemaer. TUL_ Ett skjema kan benyttes i flere skjemasett. TUL_ I tjenesteutviklingsverktøyet er det mulig å definere og vedlikeholde hvilke skjema som ligger i et skjemasett også etter at skjemasettet er produksjonssatt. TUL_ Tjenesteutvikler kan angi om sluttbruker kan fylle ut kun én eller flere instanser av samme skjema i ett skjemasett 11

12 Relatert dokumentasjon Dokument Type Kommentar AP353 Sub-component Design Definition TUL Service AP353 Sub-component Design definition TUL Service Edition AP311 Service Definition High Design Level TUL Service Edition AP311 Service Definition High Design Level TUL Service AP311 Service Definition High Design Level TUL Form Set AP311 Service Definition High Design Level TUL Workflow AP347 Page Specification Design High Level TUL Metadata Edition AP347 Page Specification Design High Level TUL Metadata Service AP347 Page Specification Design High Level - TUL - Workflow AP347 Page Specification High Level TUL Formset Design 12