KnowledgeBase

Example

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

Example

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

Example

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

Example 1 Export calculation messages as .xml.

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

In some circumstances, the status of an attribute may be "locked." These attributes cannot be changed via script. For example, this is the case if specification of the attribute value would lead to overdetermination of the model.

Example 

If the option for "Specification of addendum modification acc. to DIN 3992" is selected from the distribution of the addendum modification pull-down menu for the cylindrical gear component in the Editor, the attributes for manually specifying the nominal addendum modification coefficient are locked and hidden.

The script checks whether the "addendum modification coefficient" attribute can be written. If so, the new value is set. If not, a message stating "nominal addendum modification coefficient cannot be written, check the distribution of the addendum modification" is shown.

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.");
}

For more information see Data integrity (EDAT/RDAT)

Example 1 Delete all RDAT values.

delRDAT();

Example 1 Clear the monitor

clearMonitor();

Example 1 Output multiple messages in a loop

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");
}

Example 1 Load a model from the specified directory.

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

The following functions are disabled:

Some scripting functions can only be executed in the GUI or in batch mode. The isBatchMode() function can be used to check which mode the FVA-Workbench is in while the script is running, and to react accordingly.

Example

If the script is executed in GUI mode, a dialog queries the user for the directory to be used. In batch mode, the directory in which the model file is located is used.

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");

Example Output version and revision number on console

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

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

Example Output different messages after a calculation, depending on the language.

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 );
    }

This function returns all messages for an executed calculation as a JSON object.

Example Output all messages for a calculation to the Scripting Monitor.

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(" ");
}

Comparison of the Messages window in the user interface with the script output in the Scripting Monitor.

Example 1 Query data from a server

The get request to the endpoint https://postman-echo.com/time/object returns the current date as a JSON string as a response. The JSON.parse command can be used to convert this string into a JSON object. The elements (properties) in the JSON object can then be accessed via the dot notation.

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);

Example 2 Authentication with username and password

The get request to the endpoint https://postman-echo.com/basic-auth/ requires username and password authentication. If the login was successful, the server returns a JSON string {"authenticated": true} .

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);

Example 3 Querying data with URL parameters

The get request to the endpoint https://postman-echo.com/response-headers can be combined with parameters such as  https://postman-echo.com/get?gear1ID=12&gear2ID=22. In this example, the endpoint returns the parameters given in the response object.

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);

Example Send data to a server

The post request to the endpoint https://postman-echo.com/post sends data to the server. For this sample server, the data sent is returned as a response. The data returned by the server depends on the particular implementation of the server. Authentication with username and password is analogous to the 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);

The following HTTP request methods are supported in the scripting of the FVA-Workbench:

Examples

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);

Example 1 Encode the string to Base64 and output it on the Scripting Monitor

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

Example 1 Decode a Base64 string and output it on the Scripting Monitor

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

Example 1 Encode a text file as Base64

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

Example Write a base64 encoded string to a text file

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

Example 1 The variable queryParameter is assigned the parameters a, b and c. The parameters contain invalid characters for URLs. These are replaced with valid characters using the encodeQueryParams() function.

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

Output of the encoded parameters to the scripting console

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