WEB BASED ARCHIEF GEBRUIKERSHANDLEIDING VERSIE 1.03
WEB BASED ARCHIEF GEBRUIKERSHANDLEIDING VERSIE 1.03
COLOFON
ONDERWERP Web Based Archief REGEL PARTNERS B.V. Hogebrinkerweg 8 Postbus 86 3870 CB Hoevelaken 033 254 48 48 (Telefoon) 033 254 48 44 (Telefax) http://www.regelpartners.nl (Internet)
[email protected] (E-mail) AUTEUR J. Timmer DATUM 13 maart 2006 VERSIE Versie 1.03 COPYRIGHT Copyright © Regel Partners B.V. 2006
Gebruikershandleiding.doc, Versie 1.03
Pagina 2
VERSIEBEHEER VERSIE
NAAM
REVISIE
1.00
J. Timmer
Definitieve versie
Gebruikershandleiding.doc, Versie 1.03
Pagina 3
INHOUDSOPGAVE 5.1
Knoppenbalk ...........................................................................................................................12
5.2
Navigatievenster......................................................................................................................13
5.3
Informatievenster ....................................................................................................................14
5.4
Statusbalk................................................................................................................................14
7.1
Gegevens invoeren .................................................................................................................17
7.2
Gegevens verwijderen.............................................................................................................17
7.3
Plaatsnaam .............................................................................................................................17
7.3.1
Selecteren ...............................................................................................................................18
7.3.2
Toevoegen ..............................................................................................................................18
7.4
Project .....................................................................................................................................19
7.4.1
Selecteren ...............................................................................................................................19
7.4.2
Toevoegen ..............................................................................................................................20
7.5
Nummer ..................................................................................................................................21
7.5.1
Selecteren ...............................................................................................................................21
7.5.2
Geschiedenis...........................................................................................................................21
7.5.3
Toevoegen ..............................................................................................................................22
7.6
Onderwerp...............................................................................................................................22
7.6.1
Selecteren ...............................................................................................................................22
7.6.2
Geschiedenis...........................................................................................................................23
7.7
Status ......................................................................................................................................23
7.7.1
Selecteren ...............................................................................................................................23
7.8
Archief .....................................................................................................................................24
7.8.1
Selecteren ...............................................................................................................................24
7.8.2
Toevoegen ..............................................................................................................................25
7.8.3
Weergeven..............................................................................................................................26
7.8.4
Bewerken ................................................................................................................................27
7.8.5
Op naam zetten.......................................................................................................................28
7.8.6
Ongedaan maken....................................................................................................................29
7.8.7
Terugzetten .............................................................................................................................30
7.8.8
Lokale kopie ............................................................................................................................32
7.8.9
Geschiedenis...........................................................................................................................33
7.8.10
Bestandsbewerkingen .............................................................................................................33
7.9
Document ................................................................................................................................35
8.1
Nieuw / Bestaand archief in (project)nummer ‘XYZ123’ .........................................................36
8.2
Bestaand archief in (project)nummer ‘Algemeen’ ...................................................................36
9.1
Installatieprocedure .................................................................................................................37
9.2
Uitvoeren .................................................................................................................................38
Gebruikershandleiding.doc, Versie 1.03
Pagina 4
10.1
Systeemeisen PC (client) ........................................................................................................41
Gebruikershandleiding.doc, Versie 1.03
Pagina 5
1
INLEIDING
Dit document beschrijft de functionaliteit van het Web Based Archief. Middels dit document kan de gebruiker op een correcte wijze projectgegevens beheren en invoeren in het Web Based Archief.
Gebruikershandleiding.doc, Versie 1.03
Pagina 6
2
DOEL
Het Web Based Archief is ontwikkeld als hulpmiddel om gebruikers te voorzien in een universele wijze van opslag van projectgegevens zoals applicatiesoftware, schakelkastschema’s, regeltechnische omschrijvingen en technische documentatie (Figuur 1). Op deze wijze worden projectgegevens op een bekende, centrale en voor iedereen toegankelijke locatie opgeslagen.
Figuur 1: mapstructuur
Alle activiteiten die uitgevoerd worden in het Web Based Archief worden vastgelegd in een geschiedenis. Deze geschiedenis kan te allen tijde ingezien worden en de gebruiker kan eventueel items toevoegen aan de geschiedenis.
Gebruikershandleiding.doc, Versie 1.03
Pagina 7
3
VERKLARENDE WOORDENLIJST
Versiebeheer Procedure waarbij diverse eigenschappen van het archief gedurende een aantal statussen worden gevalideerd. Daarbij worden alle bewerkingen op het archief vastgelegd in de geschiedenis van archief.
Archief Een item in het Web Based Archief waarop versiebeheer wordt toegepast.
Document Een item in het Web Based Archief waarop geen versiebeheer van toepassing is.
Aanmeldprocedure Tijdens deze procedure worden de aanmeldgegevens (e-mailadres en toegangscode) gevalideerd.
Waarschuwingen Wanneer de gebruiker een invoerveld niet of onjuist ingevoerd heeft, zal dit resulteren in een waarschuwing. Deze wordt weergegeven in het scherm in rode letters. Zodra een waarschuwing gegenereerd wordt, wordt de bewerking afgebroken en zal de gebruiker de oorzaak van de waarschuwing moeten herstellen alvorens de uitvoering opnieuw gestart kan worden.
Foutmeldingen/Uitzonderingen Een onverwachte uitvoering van de toepassing. Een foutmelding/uitzondering resulteert in een onbekende uitvoer en kan tot gevolg hebben dat het Web Based Archief afgesloten wordt. Een foutmelding/uitzondering wordt automatisch gemeld aan de auteur!
Op naam zetten (Alleen beschikbaar met versiebeheer) Procedure waarbij een gebruiker de eigenaar van een archief wordt. Hierbij kan een andere gebruiker dit archief niet op naam zetten (Figuur 2).
Figuur 2: op naam zetten
Gebruikershandleiding.doc, Versie 1.03
Pagina 8
Ongedaan maken (Alleen beschikbaar met versiebeheer) Procedure waarbij de eigenaar van een archief de procedure ‘op naam zetten’ ongedaan maakt.
Terugzetten (Alleen beschikbaar met versiebeheer) Met behulp van deze procedure kan de eigenaar van een archief het archief terugzetten waardoor de gebruiker geen eigenaar meer is (Figuur 3).
Figuur 3: terugzetten
Lokale kopie (Alleen beschikbaar met versiebeheer) Middels deze procedure kan een gebruiker een archief gebruiken zonder eigenaar van het archief te worden (Figuur 4). Hierbij is terugzetten van het archief niet mogelijk!
Figuur 4: lokale kopie
Nulmeting De voorgaande geschiedenis en statussen zijn niet bekend van een toe te voegen archief.
ZIP-bestand Een gecomprimeerd bestand waarin zich meerdere bestanden bevinden. De compressiefactor is ingesteld op circa 80%.
Digitale handtekening Met behulp van een digitale handtekening wordt gecontroleerd of het bestand beschadigd is geraakt tijdens het kopiëren van en naar de server. Deze handtekening wordt gegenereerd middels het MD5algoritme en is voor elk archief uniek. De gebruiker kan middels de toepassing ‘Handtekeningcontrole’ controleren of het bestand beschadigd is tijdens het kopiëren. De toepassing ‘Handtekeningcontrole’ kan gevonden worden in het optiesvenster (Figuur 5).
Figuur 5: optiesvenster
Server
Gebruikershandleiding.doc, Versie 1.03
Pagina 9
De PC waarop het Web Based Archief geïnstalleerd is.
Client De PC van de gebruiker.
Browser Toepassing waarmee internetpagina’s weergegeven kunnen worden.
Cookies Bestanden op de PC van de gebruiker waarin zich (persoonlijke) informatie kan bevinden. Om veiligheidsredenen kan het gebruik van cookies uitgeschakeld zijn in een browser waardoor enkele functies in het Web Based Archief niet beschikbaar zijn.
Web-toepassing Het Web Based Archief is een web-toepassing. Dit houdt in dat met behulp van een browser op de client verbinding gemaakt wordt met de server.
Tijdelijke mappen Voor elke bewerking op een archief/document worden tijdelijke mappen op de server gebruikt. Alle tijdelijke
mappen
hebben
een
naam
met
de
opmaak
‘{aaaaaaaa-bbbb-cccc-dddd-
eeeeeeeeeeee}‘. Deze tijdelijke mappen worden regelmatig verwijderd indien deze niet (meer) in gebruik zijn. Met behulp van de standaard ‘Windows’-functies ‘Kopiëren’, ‘Knippen’ en ‘Plakken’ kunnen de bestanden van en naar de tijdelijke mappen gekopieerd worden.
Elektronische herinnering Elke eigenaar van een archief ontvangt, nadat deze een archief langer dan een bepaalde periode op naam heeft staan, elke dag een elektronische herinnering (e-mail). De periode is ingesteld op vijf dagen.
Extra informatie Een onderstreept item in het is voorzien van extra informatie over het item. Deze informatie wordt weergegeven wanneer de gebruiker de muis over het onderstreepte item beweegt.
Verwachte invoer Voor bijna alle invoervelden geldt een verwachte invoer. Deze invoer wordt weergegeven wanneer de gebruiker de muis over het onderstreepte item beweegt.
FTP – File Transfer Protocol Het Web Based Archief maakt gebruik van dit protocol voor bestandsuitwisseling tussen server en client.
Gebruikershandleiding.doc, Versie 1.03
Pagina 10
4
GEBRUIKERSNIVEAUS
Elke gebruiker van het Web Based Archief heeft een aanmeldniveau. Afhankelijk van dit aanmeldniveau heeft een gebruiker rechten. Gebruikers, rechten en niveaus worden beheerd door een systeembeheerder van het Web Based Archief. Het Web Based Archief bevat de onderstaande gebruikersniveaus waarbij niveau ‘1’ het laagste en niveau ‘6’ het hoogste niveau is. Het standaard aanmeldniveau is ‘Gebruiker’. Een niveau heeft altijd de rechten van een onderliggend (lager) niveau.
Uitgeschakeld (Niveau 1) Alle uitgeschakelde gebruikers kunnen niet aanmelden en daardoor geen wijzigingen maken
Gast (Niveau 2) Een gastgebruiker kan bladeren door de projectstructuur in het Web Based Archief. Wijzigingen maken is niet mogelijk.
Gebruiker (Niveau 3) Een gebruiker kan archieven en documenten toevoegen en wijzigen.
Productbeheerder (Niveau 4) Een productbeheerder is verantwoordelijk voor het testen van archieven.
Projectbeheerder (Niveau 5) Een projectleider kan naast het testen van archieven tevens projecten en onderliggende mappen aanmaken.
Systeembeheerder (Niveau 6) Een systeembeheerder kan plaatsnamen aanmaken en heeft direct toegang tot de database.
Gebruikershandleiding.doc, Versie 1.03
Pagina 11
5
GEBRUIKERSOMGEVING
De gebruikersomgeving van het Web Based Archief bestaat uit een aantal onderdelen, namelijk een knoppenbalk (boven), een navigatievenster (links), het informatievenster (rechts) en statusbalk (onder).
5.1
KNOPPENBALK
De knoppenbalk (Figuur 6) bevat de onderstaande knoppen. Met behulp van deze knoppen kunnen algemene acties uitgevoerd worden.
Figuur 6: knoppenbalk
Afmelden Middels deze knop wordt de gebruiker correct afgemeld bij het Web Based Archief.
Startpagina Weergave startpagina. Deze pagina wordt weergegeven zodra de aanmeldprocedure correct is uitgevoerd. De gebruiker wordt op deze pagina (Figuur 7) welkom geheten en de op naam staande archieven worden op deze pagina in het rood getoond. Wanneer een gebruiker een archief te lang op naam heeft staan ontvangt deze elke dag een elektronische herinnering. De gebruiker kan het Web Based Archief openen door op de koppeling ‘Web Based Archief openen…’ te klikken.
Figuur 7: startpagina
Gebruikershandleiding.doc, Versie 1.03
Pagina 12
Weergave Met behulp van deze knop wordt het navigatievenster verborgen/weergegeven.
Vernieuwen Met behulp van deze knop wordt het venster opnieuw geladen. LET OP: wanneer de gebruiker de ‘Vernieuwen’-knop van de browser gebruikt, wordt de startpagina weergegeven in plaats van de huidige pagina!
Afdrukken Drukt het huidige venster af.
Zoeken Middels deze functie kan de gebruiker naar items zoeken in het Web Based Archief.
Help Weergave van de elektronische help. Aan de rechterzijde in de knoppenbalk zijn de huidige gebruiker, datum en tijd zichtbaar.
5.2
NAVIGATIEVENSTER
Het navigatievenster zoals is weergegeven in Figuur 8 bevat diverse subvensters waarmee de verschillende onderdelen in het Web Based Archief bediend kunnen worden.
Figuur 8: navigatievenster
Indien de inhoud van de subvensters niet zichtbaar is, kan de inhoud zichtbaar gemaakt worden door te klikken op het ‘+’-teken.
Locatievenster
Gebruikershandleiding.doc, Versie 1.03
Pagina 13
Dit venster geeft de locatie aan. In dit venster kunnen (nog) geen items bediend worden.
Selectievenster Middels dit venster kan de gebruiker bladeren in de niveaus. Met de knop ‘Niveau omhoog’ wordt het bovenliggende niveau weergegeven.
Beheervenster Dit venster bevat, indien aanwezig in combinatie met een voldoende hoog aanmeldniveau, items voor het beheer van het geselecteerde niveau.
Optiesvenster Dit venster bevat verschillende opties, waaronder deze gebruikershandleiding, werkinstructies en handtekeningcontrole.
5.3
INFORMATIEVENSTER
Dit deelvenster geeft informatie weer over de huidige locatie in het Web Based Archief. Wanneer een item onderstreept is, kan de gebruiker door de muis over het gestreepte item te bewegen, extra informatie weergeven.
5.4
STATUSBALK
De statusbalk bevat de onderstaande koppelingen (hyperlinks).
Opmerkingen? Wanneer de gebruiker opmerkingen heeft over de werking van het Web Based Archief kunnen deze opmerkingen met behulp van het dan volgende scherm medegedeeld worden aan de auteur.
Contactinformatie Dit venster geeft de contactinformatie weer.
Versiebeheer Versies weergeven van alle geïnstalleerde modules van het Web Based Archief. Tevens wordt de licentiehouder weergegeven.
Disclaimer Weergave disclaimer.
Gebruikershandleiding.doc, Versie 1.03
Pagina 14
6
AANMELDEN
Voordat het Web Based Archief geopend kan worden, dient de gebruiker zich aan te melden. Met behulp van Microsoft Internet Explorer (Figuur 9) dient genavigeerd te worden naar de volgende locatie http://192.168.0.98. LET OP: deze toepassing is ontwikkeld voor Microsoft internet Explorer 6.0 of hoger. Elke andere, niet op Microsoft Internet Explorer gebaseerde, browser wordt op dit moment niet ondersteund! De meest recente versie van de genoemde browser kan gevonden worden op de website van Microsoft (http://www.microsoft.com).
Figuur 9: Microsoft Internet Explorer
De gebruiker dient, in het dan weergegeven venster (Figuur 10), het e-mailadres en de daarbijbehorende toegangscode in te voeren en de aanmeldprocedure te starten door op de knop ‘OK’ te klikken. Wanneer de optie ‘E-mailadres opslaan’ aangevinkt wordt, wordt het e-mailadres opgeslagen zodat deze bij de volgende aanmelding automatisch ingevoerd wordt. LET OP: deze optie maakt gebruik van cookies.
Figuur 10: aanmelden
Gebruikershandleiding.doc, Versie 1.03
Pagina 15
Wanneer de gebruiker geen toegangscode heeft of deze is vergeten, kan met behulp van de knop ‘Toegangscode vergeten?’ in de knoppenbalk de toegangscode opnieuw aangevraagd worden. De gebruiker ontvangt de toegangscode binnen enkele minuten per e-mail.
Gebruikershandleiding.doc, Versie 1.03
Pagina 16
7
NAVIGEREN
7.1
GEGEVENS INVOEREN
Bij het uitvoeren van een procedure (toevoegen, op naam zetten en dergelijke) dienen verschillende invoervelden ingevoerd te worden alvorens de procedure succesvol uitgevoerd kan worden. In de meeste gevallen dienen de invoervelden verplicht ingevoerd te worden. Deze velden zijn gemarkeerd met een (aantal) ‘*’-teken(s). Daarnaast kan voor een invoerveld een verwachte invoer gelden. Zodra een procedure gestart wordt, wordt gecontroleerd of alle invoervelden correct zijn ingevoerd. Indien een veld onjuist of niet ingevoerd is, wordt dit veld gemarkeerd met rood ‘!’-teken en wordt de procedure afgebroken. Motivaties van de gebruiker dienen, afhankelijk van de bewerking, te bestaan relevante gegevens, zoals bijvoorbeeld een bonnummer, een documentnaam van het functionele ontwerp, naam van de opdrachtgever en dergelijke. Alle motivaties en opmerkingen van gebruikers worden regelmatig gecontroleerd op inhoud!
LET OP: ondanks de uitgebreide invoercontrole is de gebruiker te allen tijde zelf verantwoordelijk voor de invoer van gegevens én de inhoud van de aangeboden bestanden! Voor productspecifieke informatie over het toevoegen van bestanden wordt u verwezen naar de werkinstructies in het Web Based Archief. Deze werkinstructies worden weergeven door, in het optiesvenster (Figuur 11) op de koppeling ‘Werkinstructies’ te klikken.
Figuur 11: optiesvenster
7.2
GEGEVENS VERWIJDEREN
In verband met de eisen van de kwaliteitsbeheerder (ISO) is het voor de gebruikers, op de systeembeheerder na, niet mogelijk om gegevens te verwijderen uit het Web Based Archief. Indien u gegevens wilt verwijderen, dient u contact op te nemen met de systeembeheerder.
7.3
PLAATSNAAM
Wanneer de gebruiker het Web Based Archief geopend heeft, wordt het hoofd-navigatievenster weergegeven waarin een plaatsnaam geselecteerd kan worden.
Gebruikershandleiding.doc, Versie 1.03
Pagina 17
7.3.1 SELECTEREN Alle projecten worden beheerd op plaatsnaam. De plaatsnamen zijn ondergebracht in secties. Een sectie kan geopend worden door in het selectievenster op het ‘+’-teken van de betreffende sectie te klikken. Alle beschikbare plaatsnamen worden daarna getoond (Figuur 12). Door op een plaatsnaam te klikken wordt de betreffende plaatsnaam geopend.
Figuur 12: plaatsnaam selecteren
7.3.2 TOEVOEGEN Klik in het beheervenster (hoofdvenster) op de knop ‘Toevoegen’ om een plaatsnaam toe te voegen. Het toevoegen van een plaatsnaam (Figuur 13) is mogelijk door een productbeheerder of ‘hoger’.
Gebruikershandleiding.doc, Versie 1.03
Pagina 18
Figuur 13: plaatsnaam toevoegen
Plaatsnaam De naam van de plaats waarin het project zich bevindt. Deze plaatsnaam moet uniek zijn in het archief.
Afkorting Een afkorting van de ingevoerde plaatsnaam. Deze afkorting (drie karakters) is onderdeel van de namen van de onderliggende archieven. Door op de knop ‘Toevoegen’ te klikken, wordt de plaatsnaam toegevoegd en het venster afgesloten. Het onderliggende hoofdvenster wordt automatisch ververst. Met behulp van de knop ‘Reset’ worden de eventueel (foutief) ingevoerde velden gewist.
7.4
PROJECT
7.4.1 SELECTEREN In een plaatsnaam worden alle beschikbare projecten weergegeven (Figuur 14). Door op een projectnaam te klikken wordt het geselecteerde project geopend.
Gebruikershandleiding.doc, Versie 1.03
Pagina 19
Figuur 14: project selecteren
7.4.2 TOEVOEGEN Klik in het beheervenster op de knop ‘Toevoegen’ om een project toe te voegen. Een project bevat de onderstaande gegevens (Figuur 15).
Figuur 15: project toevoegen
Projectnaam De naam van het project. Een projectnaam moet uniek zijn in een plaatsnaam.
Gebruikershandleiding.doc, Versie 1.03
Pagina 20
Afkorting Een afkorting van de projectnaam. Deze afkorting dient maximaal vijf karakters te bevatten en is onderdeel van de namen van de onderliggende archieven.
Projectleider De projectleider van het project. Door op de knop ‘Toevoegen’ te klikken, wordt het project toegevoegd en het venster afgesloten. Het onderliggende hoofdvenster wordt automatisch ververst. Met behulp van de knop ‘Reset’ worden de eventueel (foutief) ingevoerde velden gewist.
7.5
NUMMER
Een project bevat ten minste één (project)nummer, namelijk ‘Algemeen’. Daarnaast kunnen er meerdere (project)nummers aanwezig zijn in een project (Figuur 16).
7.5.1 SELECTEREN Door op een nummer te klikken wordt het geselecteerde nummer geopend.
7.5.2 GESCHIEDENIS Het informatievenster bevat een sectie ‘Geschiedenis’. Wanneer met behulp van het ‘+’-teken deze sectie geopend wordt, kan met behulp van de knop ‘Weergeven’ de geschiedenis van alle, in dit project, aanwezige nummers weergegeven worden.
Figuur 16: nummer selecteren
Gebruikershandleiding.doc, Versie 1.03
Pagina 21
7.5.3 TOEVOEGEN Klik in het beheervenster (hoofdvenster) op de knop ‘Toevoegen’ om een nummer toe te voegen. Tijdens het toevoegen van een nummer dienen de onderstaande gegevens ingevoerd te worden (Figuur 17).
Figuur 17: nummer toevoegen
Nummer Het (project)nummer. Een (project)nummer moet uniek zijn in een project.
Alias In enkele gevallen is een projectnummer bekend onder een naam. In dit geval kan de alias ingevoerd worden waaronder het (project)nummer bekend is. Door op de knop ‘Toevoegen’ te klikken, wordt het nummer toegevoegd en het venster afgesloten. Het onderliggende hoofdvenster wordt automatisch ververst. Met behulp van de knop ‘Reset’ worden de eventueel (foutief) ingevoerde velden gewist.
7.6
ONDERWERP
7.6.1 SELECTEREN Een (project)nummer bevat diverse onderwerpen (Figuur 18) en kan worden geselecteerd door op het betreffende onderwerp te klikken. Deze onderwerpen worden beheerd door een systeembeheerder en kunnen niet door een gebruiker worden toegevoegd.
Gebruikershandleiding.doc, Versie 1.03
Pagina 22
7.6.2 GESCHIEDENIS Ook dit informatievenster bevat een sectie ‘Geschiedenis’. Wanneer met behulp van het ‘+’-teken deze sectie geopend wordt, kan met behulp van de knop ‘Weergeven’ de geschiedenis van het geselecteerde nummer weergegeven worden.
Figuur 18: onderwerp selecteren
7.7
STATUS
7.7.1 SELECTEREN Wanneer versiebeheer wordt toegepast op een archief, dan heeft dit archief één van vijf statussen (Figuur 19). Deze statussen worden beheerd door een systeembeheerder en kunnen niet door een gebruiker worden toegevoegd. Alle, in dit nummer, aanwezige archieven worden per status weergegeven.
Gebruikershandleiding.doc, Versie 1.03
Pagina 23
Figuur 19: status selecteren
7.8
ARCHIEF
7.8.1 SELECTEREN Zodra een status gekozen is, worden de beschikbare archieven in de status weergegeven (Figuur 20). Door op een archief te klikken, wordt een archief geopend.
Figuur 20: archief selecteren
Gebruikershandleiding.doc, Versie 1.03
Pagina 24
7.8.2 TOEVOEGEN Het toevoegen van een archief kan alleen in de status ‘In ontwikkeling’/’Ontwerp’. Klik in het beheervenster op de knop ‘Toevoegen’ om een archief toe te voegen. Een archief bevat onderstaande gegevens (Figuur 21).
Figuur 21: archief toevoegen
Naam De naam van het archief die gepresenteerd wordt in het navigatievenster. De naam van het archief moet uniek zijn in het project.
Product Een archief behoort tot een product. Afhankelijk van het geselecteerde product, heeft een archief verplicht aan te bieden bestanden (zie werkinstructies).
Bestandsnaam De bestandsnaam waarmee het archief op de server is opgeslagen. Zoals eerder genoemd, zijn de afkortingen van de plaatsnaam en projectnaam in de bestandsnaam opgenomen alsmede twee unieke volgnummers die voortkomen uit de database.
Aanvullende informatie/Belangrijke informatie Een gebruiker kan aanvullende en/of belangrijke informatie toevoegen aan het archief. Deze informatie wordt in deze velden weergegeven.
Dit archief is een kopie van archief uit ‘Algemeen’ (Indien aanwezig) Selecteer deze optie en het betreffende archief wanneer dit als bron voor het huidige archief dient.
Gebruikershandleiding.doc, Versie 1.03
Pagina 25
Betreft nulmeting Selecteer deze optie wanneer het archief in de status ‘Geladen’ toegevoegd dient te worden. De onderliggende statussen worden overgeslagen.
Bronbestanden toevoegen Wanneer deze knop geselecteerd wordt, wordt een venster geopend waarin de gebruiker de te archiveren bestanden dient te kopiëren. Het geopende venster (Figuur 22) is een tijdelijke map op de server en wordt middels het FTP-protocol benaderd.
Figuur 22: bestanden toevoegen
Met behulp van de standaard ‘Windows’-functies ‘Kopiëren’, ‘Knippen’ en ‘Plakken’ kunnen bestanden toegevoegd worden aan deze tijdelijke map. Zodra de benodigde bestanden zijn toegevoegd aan de map, kan het venster afgesloten worden. Door op de knop ‘Toevoegen’ te klikken, wordt het arhief toegevoegd en het venster afgesloten. Het onderliggende hoofdvenster wordt automatisch ververst. Met behulp van de knop ‘Reset’ worden de eventueel (foutief) ingevoerde velden gewist.
7.8.3 WEERGEVEN Zodra een archief geselecteerd is, wordt de algemene informatie en de huidige status van het archief weergegeven almede de bewerkingen die op het archief van toepassing zijn (Figuur 23).
Gebruikershandleiding.doc, Versie 1.03
Pagina 26
Figuur 23: archief weergeven
Een deel van de algemene informatie is reeds behandeld in alinea 7.8.2. De overige nog niet behandelde items worden hieronder weergegeven. Versie Het aantal handelingen dat een archief ondergaan heeft. Een omschrijving van deze handelingen worden tussen haken naast ‘Versie’ gepresenteerd.
Digitale handtekening De digitale handtekening wordt intern gebruikt voor controle tijdens bestandsbewerkingen. Daarnaast kan de gebruiker middels de toepassing ‘Handtekeningcontrole’ het archief op beschadigingen controleren. Het gebruik van de digitale handtekening en de toepassing ‘Handtekeningcontrole’ wordt uitvoerig besproken in hoofdstuk 9.
Eigenaar Wanneer het archief op naam gezet is, wordt de naam van de eigenaar weergegeven.
Sinds Wanneer het archief een eigenaar heeft, wordt de datum- en tijdstempel weergegeven van het tijdstip waarop het archief op naam gezet is.
7.8.4 BEWERKEN Enkele gegevens van het archief kunnen na het toevoegen gewijzigd worden. Hiervoor dient in het navigatievenster op de koppeling ‘Bewerken’ geklikt te worden. In het dan volgende venster kunnen enkele eigenschappen van het archief gewijzigd worden (Figuur 24).
Gebruikershandleiding.doc, Versie 1.03
Pagina 27
Figuur 24: archief bewerken
Naam De naam van het archief die gepresenteerd wordt in het navigatievenster. De naam van het archief moet uniek zijn in het project.
Aanvullende informatie/Belangrijke informatie Een gebruiker kan aanvullende en/of belangrijke informatie toevoegen aan het archief. Deze informatie wordt in deze tekstvelden weergegeven.
7.8.5 OP NAAM ZETTEN Bij deze procedure dient de gebruiker de volgende gegevens in te voeren (Figuur 25).
Gebruikershandleiding.doc, Versie 1.03
Pagina 28
Figuur 25: archief op naam zetten
Basis De reden waarom het op naam zetten gebeurt.
Motivatie van de bewerking De gebruiker dient hier een uitgebreide motivatie of opmerking in te voeren
Lokale kopie van gehele project Voor enkele producten is het van belang dat alle archieven aanwezig zijn. Met behulp van deze optie wordt het huidige archief op naam gezet en van de overige archieven in het project wordt een lokale kopie gegenereerd. LET OP: indien deze optie geselecteerd wordt, kan het uitvoeren van de procedure enige tijd in beslag nemen! Zodra deze procedure succesvol afgerond is, kunnen de opgeslagen bestanden weergegeven worden door op de knop ‘Map openen’ te klikken. Voor meer informatie over de bestandstypen en het kopiëren van bestanden wordt verwezen naar de alinea 7.8.10.
7.8.6 ONGEDAAN MAKEN Bij deze procedure dient de gebruiker de volgende gegevens in te voeren (Figuur 26).
Gebruikershandleiding.doc, Versie 1.03
Pagina 29
Figuur 26: ongedaan maken
Motivatie van de bewerking De gebruiker dient hier een uitgebreide motivatie of opmerking in te voeren.
7.8.7 TERUGZETTEN Bij deze procedure dient de gebruiker de volgende gegevens in te voeren (Figuur 27).
Figuur 27: archief terugzetten
Omschrijving van wijzigingen
Gebruikershandleiding.doc, Versie 1.03
Pagina 30
In dit veld dient de gebruiker een uitgebreide omschrijving van de wijzigingen in te voeren.
Nieuwe status Met behulp van deze optie kan de gebruiker kiezen welke nieuwe status het archief krijgt.
Inhoud van archief betreft FAT/SAT Selecteer deze optie wanneer het archief een ‘Factory Acceptance Test‘ of ‘Site Acceptance Test’ betreft. De keuze tussen FAT en SAT wordt afgeleid van de huidige status. Wanneer deze optie aangevinkt wordt, wordt een kopie van dit archief bewaard en kan, indien nodig, hierop teruggevallen worden. De FAT/SAT-versie van het archief wordt niet getoond in het Web Based Archief.
Aanvullende informatie/Belangrijke informatie Een gebruiker kan aanvullende en/of belangrijke informatie toevoegen aan het archief. Deze informatie wordt in deze tekstvelden weergegeven.
Bronbestand als ZIP-bestand De gebruiker kan deze optie selecteren wanneer de te archiveren bestanden opgeslagen zijn in één ZIP-bestand. Deze optie kan van toepassing zijn wanneer de gebruiker vanaf een andere locatie dan het lokale bedrijfsnetwerk de bestanden ter archivering aanbiedt. Zodra de procedure gestart wordt, wordt het ZIP-bestand gedécomprimeerd en op een, voor het Web Based Archief, juiste wijze gecomprimeerd.
Bronbestanden toevoegen Wanneer deze knop geselecteerd wordt, wordt een venster geopend waarin de gebruiker de te archiveren bestanden dient te kopiëren. Het geopende venster (Figuur 28) is een tijdelijke map op de server en wordt middels het FTP-protocol benaderd.
Figuur 28: bronbestanden toevoegen
Gebruikershandleiding.doc, Versie 1.03
Pagina 31
Met behulp van de standaard ‘Windows’-functies ‘Kopiëren’, ‘Knippen’ en ‘Plakken’ kunnen bestanden toegevoegd worden aan deze tijdelijke map. Zodra de benodigde bestanden zijn toegevoegd aan de map, kan het venster afgesloten worden.
Goedgekeurd of getest door (Alleen in status ‘Te testen’/’Definitief’) Het archief dient gecontroleerd te worden door een productbeheerder. Wanneer de productbeheerder niet aanwezig is, kan de projectleider het archief goedkeuren. De procedure dient gestart te worden door de genoemde personen.
Toegangscode De hierboven genoemde persoon dient zijn/haar toegangscode in te voeren alvorens de procedure gestart kan worden.
7.8.8 LOKALE KOPIE Bij deze procedure dient de gebruiker de volgende gegevens in te voeren (Figuur 29).
Figuur 29: lokale kopie
Motivatie van de bewerking De gebruiker dient hier een uitgebreide motivatie of opmerking in te voeren.
Lokale kopie van gehele project Voor enkele producten is het van belang dat alle archieven aanwezig zijn. Met behulp van deze optie wordt het huidige archief op naam gezet en van de overige archieven in het project wordt een lokale kopie gegenereerd. LET OP: indien deze optie geselecteerd wordt, kan het uitvoeren van de procedure enige tijd in beslag nemen!
Gebruikershandleiding.doc, Versie 1.03
Pagina 32
Zodra deze procedure succesvol afgerond is, kunnen de opgeslagen bestanden weergegeven worden door op de knop ‘Map openen’ te klikken. Voor meer informatie over de bestandstypen en het kopiëren van bestanden wordt verwezen naar de alinea 7.8.10.
7.8.9 GESCHIEDENIS Het informatievenster bevat een sectie ‘Geschiedenis’ die met behulp van het ‘+’-teken geopend wordt.
7.8.9.1
WEERGEVEN
Middels de knop ‘Weergeven’ wordt de geschiedenis van het geselecteerde archief weergegeven.
7.8.9.2
TOEVOEGEN
Met behulp van de knop ‘Item toevoegen’ kan een item aan de geschiedenis van het archief toegevoegd worden (Figuur 30). In het dan volgende venster dient een opmerking ingevoerd te worden. Door op de knop ‘Toevoegen’ te klikken, wordt het item toegevoegd aan de geschiedenis en wordt het venster afgesloten. Met behulp van de knop ‘Reset’ worden de eventueel (foutief) ingevoerde velden gewist.
Figuur 30: geschiedenisitem toevoegen
7.8.9.3
OPSLAAN
Met behulp van de knop ‘Opslaan’ wordt de gehele geschiedenis opgeslagen in een tijdelijke map. Deze map kan geopend worden middels de knop ‘Map openen’ in het hoofdvenster (Figuur 23).
7.8.10 BESTANDSBEWERKINGEN Bij uitvoeren van onder andere de procedures ‘Op naam zetten’ en ‘Lokale kopie’ worden bestanden opgeslagen in een tijdelijke map (Figuur 31). Met behulp van de standaard ‘Windows’-functies
Gebruikershandleiding.doc, Versie 1.03
Pagina 33
‘Kopiëren’, ‘Knippen’ en ‘Plakken’ dienen deze bestanden naar een map op de lokale harde schijf gekopieerd te worden.
Figuur 31: bestandstypen
Hieronder worden deze mogelijk aangeboden bestanden, en het gebruik hiervan, nader omschreven.
Archiefbestand (
.exe) Dit gecomprimeerde bestand bevat het archief. Wanneer dit bestand uitgevoerd wordt, wordt de gebruiker gevraagd een locatie in te voeren waar de bestanden gedécomprimeerd dienen te worden (Figuur 32).
Figuur 32: archief décomprimeren
Middels de knop ‘…’ kan de gebruiker een doellocatie selecteren (Figuur 33).
Figuur 33: doellocatie selecteren
Gebruikershandleiding.doc, Versie 1.03
Pagina 34
Daarnaast kan de gebruiker in het invoerveld een doellocatie invoeren (Figuur 32). Wanneer de doellocatie niet aanwezig, wordt gevraagd of deze gegenereerd dient te worden (Figuur 34).
Figuur 34: doellocatie genereren
Zodra dit venster (Figuur 32) bevestigd wordt met de knop ‘OK’, worden de bestanden gedécomprimeerd in de opgegeven locatie. Zodra deze procedure voltooid is, wordt het onderstaande venster weergegeven (Figure 35).
Figure 35: decomprimeren voltooid
Controlebestand (.md5) Dit bestand bevat de digitale handtekening van een archiefbestand en bevat tevens een digitale handtekening van het controlebestand zelf waardoor gecontroleerd kan worden of het controlebestand beschadigd is. Dit bestand is benodigd voor het controleren van de digitale handtekening van het archiefbestand. Het gebruik van dit bestand wordt nader omschreven in hoofdstuk 9.
Geschiedenisbestand (Geschiedenis - .xml) Dit bestand bevat de geschiedenis van het archief in een gestructureerde opmaak. Wanneer dit bestand wordt geopend, wordt met behulp van het tevens aanwezige opmaakbestand de geschiedenis in een prettig leesbare opmaak weergegeven.
Opmaakbestand (Style.xsl) Met behulp van dit bestand wordt het geschiedenisbestand voorzien van een prettig leesbare opmaak.
LET OP: zowel het opmaakbestand als het geschiedenisbestand zijn benodigd voor een correcte weergave van de geschiedenis van het archief!
7.9
DOCUMENT
Dit type is nog niet geïmplementeerd. Deze implementatie, aangeduid met fase II, wordt in een later stadium uitgevoerd.
Gebruikershandleiding.doc, Versie 1.03
Pagina 35
8
LEVENSLOOP VERSIEBEHEER
De levensloop van een archief wordt in de onderstaande alinea's toegelicht. Met behulp van de eerder genoemde procedures worden de archieven verplaatst tussen de verschillende stadia. Zolang deze procedures gevolgd worden, is het versiebeheer gewaarborgd en wordt het verlies van gegevens geminimaliseerd! Hierbij wordt van de onderstaande stadia uitgegaan.
Beschikbare stadia 1. In ontwikkeling/Ontwerp 2. Te testen/Definitief 3. Te laden/Productie 4. Geladen/Revisie 5. Uit beheer/Uit beheer
8.1
NIEUW / BESTAAND ARCHIEF IN (PROJECT)NUMMER ‘XYZ123’
De stadia 1 tot en met 4 worden afgehandeld. Bij terugzetten in stadium 4 dient de optie ‘Verplaatsen naar ‘Algemeen’’ aangevinkt te worden. Hierbij wordt het archief verplaatst naar nummer ‘Algemeen’.
8.2
BESTAAND ARCHIEF IN (PROJECT)NUMMER ‘ALGEMEEN’
In het (project)nummer ‘Algemeen’ dient het archief op naam gezet te worden in stadium 4. Hiermee wordt voorkomen dat er wijzigingen uitgevoerd worden door andere gebruikers dan de eigenaar. Bovendien blijft het archief beschikbaar voor ‘storingen’. Het op naam gezette archief wordt in een nieuw (project)nummer toegevoegd in status 1. De stadia 1 tot en met 4 worden afgehandeld. Zodra de ontwikkeling afgerond is, dient een lokale kopie gegenereerd te worden uit stadium 4 en deze wordt teruggezet in stadium 4 in (project)nummer ‘Algemeen’.
Gebruikershandleiding.doc, Versie 1.03
Pagina 36
9
HANDTEKENINGCONTROLE
Tijdens het kopiëren van bestanden kan een archief, door diverse oorzaken, beschadigd raken. Wanneer dit niet opgemerkt wordt, is de kans aanwezig dat beschadigde gegevens worden gebruikt. Om deze situatie te voorkomen, is de toepassing ‘Handtekeningcontrole’ ontwikkeld. Deze toepassing maakt gebruik van de eerder genoemde digitale handtekening.
9.1
INSTALLATIEPROCEDURE
Voordat deze toepassing gebruikt kan worden dient deze eerst geïnstalleerd te worden. De installatieprocedure is beschikbaar in het Web Based Archief in het optiesvenster (Figuur 36).
Figuur 36: optiesvenster
Zodra deze optie geselecteerd wordt, wordt gevraagd of het bestand opgeslagen of uitgevoerd dient te worden. Selecteer ‘Openen’ (of ‘Open’ bij een Engelstalige versie van Microsoft Internet Explorer) (Figuur 37).
Figuur 37: 'Handtekeningcontrole' openen
Het bestand wordt geopend en de installatieprocedure wordt gestart. LET OP: Om eventuele problemen te voorkomen, wordt aangeraden om de voorgestelde doellocatie niet te wijzigen! Klik in het startscherm op de knop ‘Install’ om de installatieprocedure voort te zetten (Figuur 38). Tijdens deze installatieprocedure wordt de voortgang weergegeven en verschijnen er een aantal vensters die na afloop automatisch gesloten worden.
Gebruikershandleiding.doc, Versie 1.03
Pagina 37
Figuur 38: installatieprocedure wordt gestart
Zodra de installatieprocedure voltooid is, wordt op het bureaublad een snelkoppeling naar ‘Handtekeningcontrole’ weergegeven (Figuur 39).
Figuur 39: Handtekeningcontrole
9.2
UITVOEREN
Om een handtekeningcontrole uit te voeren dient de toepassing gestart te worden. In het hoofdvenster (Figuur 40) dient het archiefbestand en het controlebestand geselecteerd te worden door, voor zowel het archiefbestand als het controlebestand, de knoppen ‘…’ te selecteren (Figuur 41).
Figuur 40: hoofdvenster 'Handtekeningcontrole'
Gebruikershandleiding.doc, Versie 1.03
Pagina 38
Figuur 41: bestanden selecteren
Tijdens het lezen van het controlebestand wordt gecontroleerd of het controlebestand beschadigd is. Wanneer het controlebestand beschadigd is, wordt een waarschuwing weergegeven (Figuur 42) en kan de handtekeningcontrole niet uitgevoerd worden. Het controlebestand dient opnieuw gekopieerd te worden!
Figuur 42: controlebestand is beschadigd
Zodra beide bestanden succesvol ingesteld zijn, wordt de knop ‘Controleren’ ingeschakeld (Figuur 40) en kan de controle uitgevoerd worden. Wanneer er tijdens deze controle een waarschuwing (Figuur 43) weergegeven wordt, is het archiefbestand beschadigd en dient het archiefbestand opnieuw gekopieerd te worden.
Figuur 43: archiefbestand is beschadigd
Indien de handtekeningcontrole succesvol uitgevoerd wordt (Figuur 44), kan het archiefbestand gebruikt worden.
Figuur 44: handtekeningcontrole succesvol voltooid
Met behulp van de knop ‘Afsluiten’ (Figuur 41). wordt de toepassing afgesloten.
Gebruikershandleiding.doc, Versie 1.03
Pagina 39
WAARSCHUWING: indien één of meerdere van de bovenstaande waarschuwingen genegeerd wordt, bestaat de kans dat een beschadigd gegevens gebruikt worden waardoor onbekende resultaten op kunnen treden! De gebruiker is zelf verantwoordelijk voor het gebruik van de toepassing ‘Handtekeningcontrole’!
Gebruikershandleiding.doc, Versie 1.03
Pagina 40
10
TECHNISCHE GEGEVENS
10.1 SYSTEEMEISEN PC (CLIENT) - Microsoft Internet Explorer 6.0 (http://www.microsoft.com) - Netwerkverbinding met Web Based Archief-server - Microsoft .NET Framework 1.1 of hoger
Gebruikershandleiding.doc, Versie 1.03
Pagina 41
NOTITIES
Gebruikershandleiding.doc, Versie 1.03
Pagina 42