FM2014: Einführung in Function Scripting by Thomas Hirt

Thomas Hirt
Einführung in FunctionScripting
FileMakerKonferenz 2014 Winterthur
www.filemaker-konferenz.com
Übergabe mehrerer Parameter an ein Script

Thomas Hirt
Was erwartet Sie?
•allgemein
•ein sehr technischer Vortrag
•eine Zusammenstellung an spezifischem Methodikwissen
•je nach Vorwissen eine steile oder weniger steile Lernkurve
•nichts Neues für erfahrene, professionelle FileMakerEntwickler
•inhaltlich
•Wir beginnen mit Grundlagen.
•Wir schreiten danach mit Siebenmeilenstiefeln voran.
•viele Details eher für'sStudium nach der Konferenz vorgesehen
•3 Themenblöcke
•Einführung
•statische Parameterauswertung
•dynamische Parameterauswertung

Thomas Hirt
Einleitung

Thomas Hirt
Was ist eine Funktion?
•Eine Funktion ist eine Abfolge von Anweisungen.
•Eine Funktion akzeptiert Eingabewerte ("Parameter").
•Eine Funktion verarbeitet die Parameter und errechnet damit oder daraus einen Rückgabewert.
•Eine Funktion wird einmal deklariert und ausprogrammiert und kann danach beliebig oft aufgerufen werden.
Rückgabewert
Param3
Param2
Param1

Thomas Hirt
Funktionen in stark typisierten Programmiersprachen
•Funktionsnamen
•Anweisungen
•Parameternamen
•Datentypen der Parameter
•Datentyp des Rückgabewertes
Name
Anweisung 1
Anweisung 2
…
Datentyp
ParamTyp1
ParamTyp2
ParamTyp3
…
ParamName1
ParamName2
ParamName3
…
Beispiel:
booleaninviteGuests(Arraynamen; Coordinatesort; Datedatum)
{
// der Funktionscode
}

Thomas Hirt
Funktionen in schwach typisierten Programmiersprachen
•Funktionsnamen
•Parameternamen
•Anweisungen
Name
Anweisung 1
Anweisung 2
Anweisung 3
…
ParameterName1
ParameterName2
ParameterName3
…
Beispiel:
inviteGuests(namen; ort; datum)
{
// der Funktionscode
}

Thomas Hirt
FileMakerCustom Functions

Thomas Hirt
FileMakerScript

Thomas Hirt
einen Parameter an ein FileMakerScript übergeben

Thomas Hirt
einen Parameter in einem FileMakerScript auslesen

Thomas Hirt
einen Parameter in einem FileMakerScript nutzen und den Rückgabewert berechnen
Set Variable [$parameter; Value:Get( ScriptParameter)]
Set Variable [$returnValue; Value: Berechnungen mit $parameter]
Exit Script [Result: $returnValue]

Thomas Hirt
FileMakerScript Parameterwie vom Hersteller vorgesehen
•Ursprünglich konnte kein Parameter an ein FileMakerSkript übergeben werden. Dies war nicht vorgesehen.
•Seit FileMaker7 akzeptiert ein FileMakerSkript von Haus aus einen einzelnen Parameter.
•Der Parameter wird über ein Formelfeld festgelegt.
•Im Skript muss der Parameter über Get( ScriptParameter) ausgelesen werden und wird typischerweise in einer lokalen Variable abgelegt.
•Es gibt innerhalb von FileMakerkeine Mechanismen, um an ein Skript mehr als einen Parameter zu übergeben.
•ACHTUNG…
•Bitte FileMakerSkripten und FileMakerCustom Functionsnicht verwechseln!
•Custom Functionsakzeptieren eine frei definierbare Anzahl von Parametern.

Thomas Hirt
"FunctionScripting"
Wenn in FileMakerSkripten Methoden eingesetzt werden, welche es erlauben, einem FileMakerSkript mehr als eine Parameter zu übergeben, wird dies als "FunctionScripting" bezeichnet.
Der Begriff "FunctionScripting" lässt sich so erklären, dass ein FileMakerSkript sich durch diese Methoden beinahe wie eine vollwertige Funktion verhält und nicht nur wie ein einfaches, parameterloses Skript.

Thomas Hirt
statische Parameterauswertung

Thomas Hirt
statische ParameterauswertungWie werden die Konzepte demonstriert?
•Jedes Konzept wird anhand eines eigenen FileMakerSkriptes vorgestellt.
•Ein Demoskript erhält (anders als in der alltäglichen Praxis) keinen sprechenden, funktionsbezogenen Namen, sondern einen Namen, der sich auf das erklärte Konzept bezieht.
•"statisch1 ( param)" => Skript 1. Konzept, Kapitel"statische Parameterzuweisung"
•"statisch4 ( artikelliste; adresse)" => Skript 4. Konzept, Kapitel "statische Parameterzuweisung"
•"dynamisch2 ( params)" => Skript 2. Konzept, Kapitel "dynamische Parameterzuweisung"
•Damit die übergebenen Parameter sowie deren Erkennung innerhalb der Skripte in den Demos gut sichtbar gezeigt werden können, werden globale Felder eingesetzt. Dies erfolgt NUR zu Demozwecken!

Thomas Hirt
statische ParameterauswertungWie werden die Konzepte demonstriert?
↕# Script Parameter auslesen
↕Set Variable [$parameter; Value:Get( ScriptParameter)]
↕#
↕# mitlokalenVariablenweiterarbeiten
↕Set Field [Hilfsfelder::STATISCH.1.OUTPUT1; $parameter]
Script Name: statisch1 ( param)
PerformScript ["statisch1 ( param)"; Parameter: Hilfsfelder::STATISCH.1.INPUT]
Skriptaufruf
nur zu Demozwecken!
Globale Felder, Globale und lokale Variablen, Literalesowie Berechnungen möglich

Thomas Hirt
statische Parameterauswertung 1
Demo

Thomas Hirt
Script Name: statisch2 ( zeit; nachricht)
16:30¶Hallo, wie geht's?
Set Variable [$params; Value:Get( ScriptParameter)]
Set Variable [$zeit; Value:GetValue( $params; 1 ) ]
Set Variable [$nachricht; Value:GetValue( $params; 2 ) ]

Thomas Hirt
↕Set Variable [$params; Value:Get( ScriptParameter)]
↕#
↕# Script Parameter aufteilen und in lokalen Variablen speichern
↕Set Variable [$zeit; Value:GetAsTime(GetValue( $params; 1 ) )]
↕Set Variable [$nachricht; Value:GetValue( $params; 2 )]
↕#
↕Set Field [Hilfsfelder::STATISCH.2.OUTPUT1; $zeit]
↕Set Field [Hilfsfelder::STATISCH.2.OUTPUT2; $nachricht]
Script Name: statisch2 ( zeit; nachricht)
explizite Typzuweisung

Thomas Hirt
Demo

Thomas Hirt
statische ParameterauswertungLimitierung
Als "Delimiter" wird jenes Zeichen oder jene Zeichenkombination bezeichnet, welche die Parameter voneinander abtrennt.
Im Deutschen kann auch der Begriff "Trennzeichen" verwendet werden.
Der Delimiter darf in den Parametern nicht vorkommen!
•PerformScript[ "statisch2 ( zeit; nachricht)"; Parameter: "16:30¶Diese Nachricht hat zwei Zeilen,¶welchedurch eine Absatzmarke getrennt sind.]
•PerformScript[ "statisch3 ( sender|msg)"; Parameter: "param1|param2"]

Thomas Hirt
Script Name: statisch3 ( sender|msg)
↕Set Variable [$positionPipeChar; Value: Position( $params; "|"; 1; 1 )]
↕Set Variable [$sender; Value: Left( $params; $positionPipeChar-1 )]
↕Set Variable [$msg; Value:Right( $params; Length( $params) -$positionPipeChar]
↕Set Field [Hilfsfelder::STATISCH.2.OUTPUT1; $sender]
↕Set Field [Hilfsfelder::STATISCH.2.OUTPUT2; $msg]
Script Parameter "en bloc" auslesen
Parameterblock in einzelne Parameter aufteilen
Parameterwerte an lokale Variablen zuordnen
mit lokalen Variablen arbeiten

Thomas Hirt
Demo

Thomas Hirt
statische ParameterauswertungLimitierung
Als "Delimiter" wird jenes Zeichen oder jene Zeichenkombination bezeichnet, welche die Parameter voneinander abtrennt.
Der Delimiter darf in den Parametern nicht vorkommen!
•PerformScript [ "statisch2 ( zeit; nachricht )"; Parameter: "16:30¶Diese Nachricht hat zwei Zeilen,¶welche durch eine Absatzmarke getrennt sind.]
•PerformScript [ "statisch3 ( sender|msg )"; Parameter: "param1|param2|enthält eine Pipe"]

Thomas Hirt
Umgehung der Limitierung –Variante 1Delimiter "codieren"
•verbotene Delimiter-Zeichen werden vor Parameterübergabe durch eine erlaubte Zeichenkombination ersetzt
•verbotenen Delimiter-Zeichen werden während Zuweisung der Parameterwerte an lokale Variablen wieder eingefügt
•2 Custom Functions
•codierung Delimiter
•decodierungDelimiter
1.param1="Hallo¶Velo!" param2=1234
2.param1="Hallo###par###Velo!" param2=1234
3.paramblock="Hallo###par### Velo!¶1234"
4.var1="Hallo###par###Velo!" var2="1234"
5.var1="Hallo¶Velo!" var2=1234

Thomas Hirt
Umgehung der Limitierung –Variante 1Delimiter "codieren"
•Custom Function1: Parameter codieren
paramEncode( Param)= Substitute ( param; "¶"; "###paragraph###" ) & "¶"
•Custom Function2: Parameter decodieren
paramDecode( Param) = Substitute ( param; "###paragraph###"; "¶" )
•Script: statisch4 ( artikelliste; adresse)
•Scriptaufruf:
PerformScript[ "statisch4 ( artikelliste; adresse)"; Parameter: paramEncode(Hilfsfelder::STATISCH.4.PARAM1 )& paramEncode(Hilfsfelder::STATISCH.4.PARAM2 )]

Thomas Hirt
statische ParameterauswertungUmgehung der Limitierung -Variante 1
↕# Script Parameter auslesenund sichtbarmachen
↕Set Field [Hilfsfelder::STATISCH.4.PARAMBLOCK; $params]
↕Set Variable [$artikelliste; Value: paramDecode( GetValue( $params; 1 ) )]
↕Set Variable [$adresse; Value: paramDecode( GetValue( $params; 2 ) )]
↕Set Field [Hilfsfelder::STATISCH.4.OUTPUT1; $artikelliste]
↕Set Field [Hilfsfelder::STATISCH.4.OUTPUT2; $adresse]
Script Name: statisch4 ( artikelliste; adresse)

Thomas Hirt
Demo

Thomas Hirt
Umgehung der Limitierung –Variante 2komplexer Delimiter
•jeder Parameter wird durch eine komplexe Zeichenfolge umfasst
•"umhüllte" Parameter werden als Parameterblock übergeben
•Parameter werden aus ihrer Umhüllung wieder herausgeschält
•2 Custom Functions
•umhüllen der Parameter mit komplexemn Delimiter
•herausschälen der einzelnen Parameter aus dem "Parameterblock"
1.param1="Hey!¶Du!" param2=1234
2.param1="##1##Hey!¶Du!##2##" param2="##1##1234##2##"
3.paramblock="##1##Hey!¶Du!## 2####1##1234##2##"
4.var1="##1##Hey!¶Du!##2##" var2="##1##1234##2##"
5.var1="Hey!¶Du!" var2=1234

Thomas Hirt
•Custom Function1: Parameterwert mit Delimiterumfassen
param( value) = "###start###" & value& "###end###"
•Custom Function2: Parameterwert aus Parameterblock zurückgewinnen
getParam( params; nr)= Let ([
_start = Position ( params; "###start###"; 1; nr ) + 11;
_end = Position ( params; "###end###"; 1; nr ) -1;
_length = _end -_start + 1
];
Middle ( params; _start; _length )
)
•Script: statisch5 ( artikelliste; adresse)
•Scriptaufruf:
PerformScript[ "statisch5 ( artikelliste; adresse)"; Parameter: param(Hilfsfelder::STATISCH.5.PARAM1 )& param( Hilfsfelder::STATISCH.5.PARAM2 )]

Thomas Hirt
↕# Script Parameter auslesenund sichtbarmachen
↕Set Field [Hilfsfelder::STATISCH.5.PARAMBLOCK; $params]
↕Set Variable [$artikelliste; Value: getParam( $params; 1 )]
↕Set Variable [$adresse; Value: getParam( $params; 2 )]
↕Set Field [Hilfsfelder::STATISCH.5.OUTPUT1; $artikelliste]
↕Set Field [Hilfsfelder::STATISCH.5.OUTPUT2; $adresse]
Script Name: statisch5 ( artikelliste; adresse)

Thomas Hirt
Demo

Thomas Hirt
dynamische Parameterauswertung

Thomas Hirt
dynamische Parameterauswertung
•Ziele
•automatische Zuordnung von Parametern zu lokalen Variablen
•standardisierter Weg, Parameter einer Funktion zu deklarieren
•Übertragung der Technik von einem FileMakerScript in ein anderes muss leicht und schnell gehen
•copy–paste
•Custom Functions
•mögliche Erweiterungen
•Reihenfolge der Parameter bei der Übergabe unwichtig
•optionale Parameter vs. Pflichtparameter
•Typprüfungen
•komplexe Validierungen
•umfassendes Error Handling

Thomas Hirt
dynamische Parameterauswertung 1fixe Parameterreihenfolge
↕Set Variable [$auswertung; Value: attributeParams( getParamsFromScriptname();Get ( ScriptParameter) ) ]
Script Name: dynamisch1 ( artikelliste; adresse)
$artikelliste
$adresse

Thomas Hirt
↕# Script Parameter sichtbarmachen(unnötig! nurDemo!)
↕Set Field [Hilfsfelder::DYNAMISCH.1.PARAMBLOCK; Get ( ScriptParameter)]
↕# Script Parameter auswerten
↕Set Variable [$auswertung; Value:attributeParams( getParamsFromScriptname();Get ( ScriptParameter) )]
↕Set Field [Hilfsfelder::DYNAMISCH.1.OUTPUT1; $artikelliste]
↕Set Field [Hilfsfelder::DYNAMISCH.1.OUTPUT2; $adresse]
Aufruf des Skriptes dynamisch1 ( artikelliste; adresse)

Thomas Hirt
PerformScript[
"dynamisch1 ( artikelliste; adresse)";
Parameter: param(value1 )& param( value2 )
]
Aufruf des Skriptes "dynamisch1 ( artikelliste; adresse)"
•Tabelle::Feldname
•$lokaleVariable
•$$GLOBALE.VARIABLE

Thomas Hirt
Demo

Thomas Hirt
An die Funktion "Evaluate()" wird ein Text übergeben, welcher danach von "Evaluate()" als Berechnung ausgewertet wird. Dies erlaubt die Zusammenstellung von Berechnungen zur Laufzeit des Skriptes.
dynamische Parameterauswertungdas zentrale "Geheimnis"
Das zentrale "Geheimnis" der dynamischen Parameterauswertung liegt in der FileMakerFunktion Evaluate!

Thomas Hirt
dynamische Parameterauswertungdas zentrale "Geheimnis"
•Let( [ $$myGlobalVar1="Hello"; $$myGlobalVar2="World" ]; 1)
•Evaluate(" Let( [ $$"& $var1 & "=" & $value1 & "; $$"& $var2 & "=" & Quote ( $value2 ) & " ]; 1) ")
Zahlenwerte
Texte, usw.

Thomas Hirt
RÜCKBLENDEdynamische Parameterauswertung 1fixe Parameterreihenfolge

Thomas Hirt
attributeParams( getParamsFromScriptname(); Get( ScriptParameter) )
START
Namen der erwarteten Parameter aus Skriptname herleiten
ersten Parameternamen aus Liste aller Parameter herleiten
ersten Parameterwert aus Parameterblock herleiten
Gibt es verbleibende Parameter?
verbleibende Parameterwerte herleiten
verbleibende Parameternamen herleiten
Variablenzuordnung basierend auf erstem Parameternamen und -wert vornehmen
ENDE
nein
ja
verbleibende Parameternamen und verbleibender Parameterblock als neue Ausgangswerte festlegen
"Rekursion"

Thomas Hirt
_attribution= Evaluate( " Let( [ $"&_currentName&"=" &Quote (_currentValue)&" ]; True)")

Thomas Hirt
dynamische Parameterauswertung 2freie Parameterreihenfolge mit Typangabe
•Da Skriptnamen in FileMaker13 (und älter) auf 100 Zeichen begrenzt sind, können nur wenige und kurze Parameternamen direkt im Skriptnamen definiert werden.
•Bei einer undefinierten Parameterreihenfolge mit Typangabe definieren wir die erwarteten Parameter INNERHALB des Skriptes in einer klar definierten Art.
•Parameter werden als eine Abfolge von Wertepaaren übergeben.
•Die Wertepaare bestehen aus Parameternamen und Parameterwert

Thomas Hirt
dynamische Parameterauswertung 2
↕# Script Parameter definieren
↕SetVariable[$erwarteteParameter; Value:"artikelnummer;number¶artikelbeschreibung;text¶anzahl;number ¶stueckpreis;number¶bestelldatum;date"]
↕# Script Parameter auswerten
↕Set Variable [$auswertung; Value:dyn2.params.calculate ( $erwarteteParameter;Get ( ScriptParameter))]
↕…
Script Name: dynamisch2 ( params)

Thomas Hirt
verbleibende Parameternamen und verbleibender Parameterblock als neue Ausgangswerte festlegen
START
Datentyp des ersten Parameters bestimmen
Name-Wert-Paar desersten Parameters auslesen
Gibt es weitere Name-Wert- Paare?
verbleibenden Parameterblock berechnen
ENDE
nein
ja
"Rekursion"
lokale Variable erzeugen aus Name-Wert-Paar mit Datentyp

Thomas Hirt
START
Datentyp des ersten Parameters bestimmen
lokale Variable aus Name- Wert-Paar erzeugen
ENDE
dyn2.params.calculate ( expectedParams; params)
dyn2.type.determine( name; expectedParams)
dyn2.param.attribute( nameValuePair; type )
"Rekursion"

Thomas Hirt
Demo

Thomas Hirt
ein guter Fachartikel zum selben Thema
•"Scriptparameter-Alte und neue Wege", Arnold Kegebein, FileMakerMagazin, 3, 2014, pp.31-34
•gut, ziemlich umfassend, empfehlenswert
•Verweise auf http://filemakerstandards.org
•extensive Sammlung von Konventionen zur FileMakerProgrammierung
•diverse bekannte "FileMakerGurus" arbeiten daran mit

Thomas Hirt
Vielen Dank unseren Sponsoren
Dankefürdas Bewertendieses Vortrages

FM2014: Einführung in Function Scripting by Thomas Hirt

Weitere ähnliche Inhalte

Andere mochten auch

Mehr von Verein FM Konferenz

FM2014: Einführung in Function Scripting by Thomas Hirt