FVA-Workbench KnowledgeBase

Beispiel

let filestatus = fileExists("c:/example/file.txt");
println(filestatus);

Beispiel Prüft, ob eine Datei lesbar ist.

let filestatus = isFileReadable("c:/example/file.txt");
println(filestatus);

Beispiel Prüft, ob eine Datei schreibbar ist.

let filestatus = isFileWriteable("c:/example/file.txt");
println(filestatus);

Beispiel 1 Berechnungsmeldungen als .xml exportieren.

exportNotifications("C:\\temp\\notifications.xml");

Attribute können unter Umständen den Status "locked" haben und nicht via Script geändert werden. Dies ist z.B. der Fall, wenn die Vorgabe des Attributwertes zu einer Überbestimmung des Modells führen würde.

Beispiel

Wurde im Editorview auf der Komponente Stirnradstufe der Dropdown-Eintrag zur Aufteilung der Profilverschiebung "Eingabe der Profilverschiebung nach DIN 3992" ausgewählt, werden die Attribute zur manuellen Eingabe des Nennprofilverschiebungsfaktors ausgeblendet und gesperrt.

Das Script prüft, ob das Attribut "addendum modification coefficient" beschreibbar ist. Wenn ja, wird der neue Wert gesetzt. Wenn nein, wird eine Meldung mit dem Hinweis "Nennprofilverschiebungsfaktor kann nicht gesetzt werden, bitte die Aufteilung Profilverschiebung prüfen" ausgegeben.

let gearID = 8;
let addendum_modification = 0.3;
if(isAttrLocked("addendum modification coefficient", gearID) == false){
    setAttr("addendum modification coefficient", gearID, addendum_modification, EDAT);
}else{
    println("Addendum modification factor cannot be set, please check the addendum modification allocation.");
}

Für weitere Informationen siehe Datenhaltung (EDAT/RDAT)

Beispiel 1 Alle RDAT-Werte löschen.

delRDAT();

Beispiel 1 Monitor leeren

clearMonitor();

Beispiel 1 Mehrere Meldungen in einer Schleife ausgeben

1var safety = 1.8;
2if(safety > 2){
3    generateReport("c:\\template.wbrep", "c:\\report.html");
4}else{
5    stopScript("The safety is: "+safety+"\nScript was stopped");
}

Beispiel 1 Lädt ein Modell aus dem angegebenen Verzeichnis.

loadModel("c:\\modell.wbpz");

Beispiel REXS-Datei validieren und Ergebnis auf der Scripting-Konsole ausgeben

let result = validateRexsModel("c:/example/test.rexs"); 
println("errors:");
for (let i = 0; i < result.errors.length; i++)
{ 
    println(i + ": "+result.errors[i].error);
}
println(" ");
println("warnings:");
for (let i = 0; i < result.warnings.length; i++){ 
    println(i + ": "+result.warnings[i].warning);
}

Folgende Funktionen werden abgeschaltet:

Einige Scripting Funktionen können nur im GUI-Modus bzw. nur im Batch-Modus ausgeführt werden. Über die isBatchMode() Funktion kann während der Scriptlaufzeit überprüft werden, in welchem Modus sich die FVA-Workbench befindet und entsprechend darauf reagiert werden.

Beispiel Schreiben einer Textdatei in ein Verzeichnis.

Wenn das Script im GUI-Modus ausgeführt wird, wird der Benutzer per Dialog nach dem zu verwendenden Verzeichnis gefragt. Im Batch-Modus wird das Verzeichnis verwendet, in dem sich die Modelldatei befindet.

let filename = "textfile.txt";
let text = "This text will be written to the file";
let directory;
let resultpath;

if (isBatchMode() == true) {
    directory = getModelProperty("FOLDER");
} else {
    directory = promptDirectory();
}

resultpath = directory+filename;
println("File written: "+resultpath);
writeToFile(resultpath, text, "c", "UTF-8");

Beispiel Versions- und Revisionsnummer auf der Konsole ausgeben

let version = getWorkbenchInfo(VERSION);
let revision = getWorkbenchInfo(REVISION);

println("FVA-Workbench "+version+" Revision No. "+revision);

Beispiel Nach einer Berechnung werden je nach Sprache unterschiedliche Meldungen ausgegeben.

1let status = runCalcMethod("001_SYSTEM_CALCULATION", 1);
2let language = getLanguage();
3let success_message = language == "de" ? "Die Berechnung war erfolgreich" : "Calculation was successful";
4let fail_message = language == "de" ? "Die Berechnung ist fehlgeschlagen" : "Calculation failed";

5if (status == 1) {
6    println(success_message);
7    } else {
8  println(fail_message );
    }

Liefert alle Meldungen zu einer durchgeführten Berechnung als JSON-Objekt zurück.

Beispiel Alle Meldungen zu einer Berechnung auf dem Scripting-Monitor ausgeben.

let notifications = getNotifications("ALL");

for(i = 0; i < notifications.length; i++) {
    let notification = notifications[i];
    println("Notification #" + i);
    println("---------------");
    println("Type:                " + notification.type);
    println("CalcMethodCompId:    " + notification.calcMethodCompId);
    println("CalcMethodCompName:  " + notification.calcMethodCompName);
    println("CalcMethodId:        " + notification.calcMethodId);
    println("CalcMethodName:      " + notification.calcMethodName);
    println("CalcStepName:        " + notification.calcStepName);
    println("Message:             " + notification.message);
    println(" ");

    let items = notification.items;

    for(j = 0; j < items.length; j++) {
	let notificationItem = items[j];
	println("   Notification Item #" + j);
	println("   ---------------------");
	println("   AttrId:   " + notificationItem.attrId);
	println("   CompId:   " + notificationItem.compId);
	println("   Message:  " + notificationItem.message);
	println("   Value:    " + notificationItem.value);
        println(" ");
    }
println(" ");
}

Vergleich der Meldungsausgabe in der Benutzeroberfläche mit der Ausgabe des Scriptes auf dem Scripting-Monitor.

Beispiel 1 Daten von einem Server abfragen

Der get-Request an den Endpunkt https://postman-echo.com/time/object gibt als Response das aktuelle Datum als JSON String zurück. Um diesen String in ein JSON Objekt zu konvertieren kann der JSON.parse Befehl verwendet werden. Dann kann über die Punktnotation auf die Elemente (Properties) im JSON Objekt zugegriffen werden.

let response = get('https://postman-echo.com/time/object');
println("Statuscode: " +response.status);
println("Message: " + response.message);

let JSON_object = JSON.parse(response.data);

println("Year: "+JSON_object.years);
println("Month: "+JSON_object.months);
println("Day: "+JSON_object.date);

Beispiel 2 Authentifizierung mit Benutzernamen und Passwort

Der get-Request an den Endpunkt https://postman-echo.com/basic-auth/ erfordert die Authentifizierung mit Benutzernamen und Passwort. Wenn die Anmeldung erfolgreich war, gibt der Server einen JSON String {"authenticated": true} zurück.

let username = "postman";
let password = "password";
let header = {};
header["Authorization"] = "Basic " + encodeBase64(username + ":" + password);

let response = get("https://postman-echo.com/basic-auth/", header);

println("--- Response ---");
println("Statuscode: " +response.status)
println("Message: " + response.message);
data = JSON.parse(response.data);
println("Login successful: " + data.authenticated);

Beispiel 3 Abfragen von Daten mit URL-Parametern

Dem get-Request an den Endpunkt https://postman-echo.com/response-headers können Parameter wie z.B. https://postman-echo.com/get?gear1ID=12&gear2ID=22 mitgegeben werden. In diesem Beispiel gibt der Endpunkt die mitgegebenen Parameter im Response Objekt wieder zurück.

let queryParams = [];
queryParams["param1"] = "Cars";
queryParams["param2"] = "Planes";

println("Endpoint (URL) with appended parameters to which the request is sent: ");
println("https://postman-echo.com/response-headers?" + encodeQueryParams(queryParams));

let response = get("https://postman-echo.com/response-headers?" + encodeQueryParams(queryParams));
println("--- Response ---");
println("Statuscode: " +response.status);
println("Message: " + response.message);
println("Payload: "  +response.data);

Beispiel Daten an einen Server senden

Der post-Request an den Endpunkt https://postman-echo.com/post sendet Daten an den Server. Bei diesem Beispielserver werden die gesendeten Daten als Antwort zurückgegeben. Welche Daten vom Server zurückgegeben werden, hängt von der jeweiligen Implementierung des Servers ab. Die Authentifizierung mit Benutzernamen und Passwort erfolgt analog zum get-Request.

let username = "user";
let password = "pass"
let header = {};
header["Authorization"] = "Basic " + encodeBase64(username + ":" + password);
let content = {"cylindrial_stage": {"helix_angle": 8, "center_distance": 125, "gear1": {"number_of_teeth": 22, "gear_width": 30}, "gear2": {"number_of_teeth": 30, "gear_width": 25}}};

let response = post('https://postman-echo.com/post', content, header);
println("--- Response ---");
println("Statuscode: "+response.status);
println("Message: "+response.message);

let result_object = JSON.parse(response.data);

println("Center distance: "+result_object.data.cylindrial_stage.center_distance);
println("Tooth width gear 1: "+result_object.data.cylindrial_stage.gear1.gear_width);

Folgende HTTP-Request Methoden werden im Scripting der FVA-Workbench unterstützt:

Beispiele

let data = {};
let header = {};
let headerForm = {};
let user = "user";
let pwd = "password";
header["Authentication"] = "basic " + encodeBase64(user)+ ":" + encodeBase64(pwd);
headerForm["Content-Type"] = "application/x-www-form-urlencoded";
let queryParams = [];
queryParams["param1"] = "cars";
queryParams["param2"] = "planes";

get("https://myServer.com/?" + encodeQueryParams(queryParams), header);
head("https://myServer.com/",  data, header);
post("https://myServer.com/",  encodeQueryParams(queryParams), headerForm);
put("https://myServer.com/",   data, header);
del("https://myServer.com/",   data, header);

get("https://myServer.com/");
head("https://myServer.com/", data);
post("https://myServer.com/", data);
put("https://myServer.com/",  data);
del("https://myServer.com/",  data);

Beispiel 1 String zu Base64 kodieren und auf dem Scripting-Monitor ausgeben

let string = "Hello Wold";
let encodedString = encodeBase64(string);
println(encodedString);

Beispiel 1 Base64 String dekodieren und auf dem Scripting-Monitor ausgeben

let base64string = "SGVsbG8gV29ybGQ=";
let decodedString = decodeBase64(base64string);
println(decodedString);

Beispiel 1 Textdatei Base64 kodieren

let filepath = "c:/example/textfile.txt";
readFileAsBase64(filepath);

Beispiel Base64 kodierten String in eine Textdatei schreiben

let filepath = "c:/example/textfile.txt";
let base64string = "SGVsbG8gV29ybGQ=";
decodeBase64ToFile(filepath, base64string);

Beispiel 1 Der Variable queryParameter werden die Parameter a, b und c zugewiesen. Die Parameter enthalten für URLs ungültige Zeichen. Diese werden mit der encodeQueryParams() Funktion durch gültige Zeichen ersetzt.

let queryParameter = [];
queryParameter["a"] = "No Spaces";
queryParameter["b"] = "No/Slashes";
queryParameter["c"] = "No ä,ö,ß";
println(encodeQueryParams(queryParameter));

Ausgabe der kodierten Parameter auf der Scripting-Konsole

a=No+Spaces&b=No%2FSlashes&c=No+%C3%A4%2C%C3%B6%2C%C3%9F