Använda avancerade verktyg > Ställa in filer för utvecklarlösningar > Dokumentera utvecklarlösningar
 

Dokumentera utvecklarlösningar

Obs!  Det här avsnittet beskriver funktioner som blir tillgängliga när inställningen Använd avancerade verktyg är vald. Mer information finns i Använda avancerade verktyg.

Du bör tillhandahålla dokumentation för din databaslösning, oavsett om det är en databas som måste öppnas i FileMaker Pro Advanced eller om det är en fristående runtime-lösning. Du kan tillhandahålla dokumentation för databaslösningar i flera olika format, t.ex. en tryckt handbok, elektroniska hjälpsystem eller fönstret Om layout som är tillgängliga från de olika layouterna i lösningen.

Skapa egna Om- och Hjälp-layouter som dokumenterar vad din databaslösning är, hur den används och vart användare kan vända sig för att få mer information. Sedan använder du de egna menyverktygen för att koppla scripts till menykommandon som leder till Om- och Hjälp-layouter.

Obs!  Hjälpsystemen i FileMaker Pro Advanced finns inte tillgängliga i runtime-program. Hjälp i statusfältet (Windows) och hjälpmarkörerna (macOS) finns emellertid tillgängliga.

Skapa en Om-layout

I licensen för FileMaker Pro Advanced anges att du för runtime-lösningar måste skapa en "Om"-layout som tillhandahåller information om hur användarna kan nå dig för att få teknisk support.

Så här skapar du en Om-layout:

1. I layoutläget klickar du på Ny layout/rapport i statusverktygsfältet.

2. Som Layoutnamn anger du Om <din lösning>.

Viktigt  För runtime-lösningar måste du inkludera ordet "Om" i layoutnamnet. Du måste även inkludera en viss typ av information i layouten. Mer information finns i Ditt ansvar som utvecklare.

3. Markera Tom.

4. Klicka på Slutför.

5. Lägg till din logotyp, övrig grafik och företagsinformation i layouten.

6. Lägg till text som meddelar användare om lösningsfilerna är skyddade med lösenord eller om fullständig behörighet har tagits bort.

7. Se Ditt ansvar som utvecklare för den exakta juridiska formuleringen.

8. Skapa en knapp så att användarna kan återgå till den primära filens huvudlayout.

9. Välj Scripts-menyn > Scriptfönster och skapa ett script som leder till Om-layouten.

10. Inkludera ordet Om i scriptets namn.

11. Skapa ett menykommando som visar Om-layouten. Mer information finns i Definiera anpassade menyer.

Så här visar du Om-layouten när runtime-programmet har startats:

1. Öppna primärfilen för databaslösningen.

2. Välj Arkiv > Filtillval.

3. På fliken Öppna i dialogrutan Filtillval väljer du Byt till layout. Markera sedan Om-layouten i listan.

Skapa en egen hjälplayout

Skapa en hjälplayout med instruktioner för hur den egna lösningen ska användas och lägg till data. Skapa sedan ett script i lösningens primärfil som visar hjälpsystemet. Använd funktionen Anpassade menyer för att göra scriptet tillgängligt som ett kommando på Hjälp-menyn.

Om du vill skapa en webbsida för att dokumentera din lösning, placerar du en webbvisare i din hjälplayout, som öppnar webbsidan.

Mer information finns i Skapa och redigera anpassade menyobjekt.

Inkludera tryckt dokumentation

Du måste ge användarna instruktioner för hur de ska installera databaslösningen. Här är en lista på saker du bör dokumentera:

minsta utrustnings- och programvarukrav

hur man installerar en färdig lösning

hur man installerar egna filer

hur man använder programvara du kan ha tagit med för:

att installera din samlade lösning

att dekomprimera dina lösningsfiler

hur man uppgraderar till nya lösningar (se Importera data till uppgraderade runtime-lösningar)

hur hjälpsystemet används

information om hur man startar databaslösningen (se Starta runtime-lösningar)

information om vad man ska göra i händelse av skadade filer (se Återskapa runtime-filer)

hur man kan nå dig för att få teknisk support

Viktigt  I den händelse dina runtime-lösningar blir skadade ska du se till att användarna antingen i den tryckta dokumentationen eller i en textfil har tillgång till e-postadressen och telefonnumret till din tekniska support. Om en databasfil är skadad kan det hända att de inte kan komma åt Om-layouten i din lösning för att få reda på hur de ska kontakta dig.

Du kan också inkludera följande rekommendationer:

Be användarna att inte byta namn på några lösningar (förutom runtime-programmet), annars kan det hända att de inte kan köra dina lösningar.

Rekommendera användarna att regelbundet ta säkerhetskopior på data. Du kanske vill automatisera en del av processen genom att inkludera scripts som sparar kopior av lösningarna. Mer information finns i Underhålla och reparera FileMaker Pro Advanced-databaser.

Relaterade avsnitt 

Om att skapa runtime-lösningar

Förbereda filer för en runtime-lösning

Binda filer till en runtime-lösning

Namnge runtime-lösningar