Change language via PLC variable

[SchneJoe]

I'm using Web IQ Designer 2.10. The Web IQ HMI will be shown in a frame inside a 3rd party HMI software. This HMI software should have the possibility to change the language of the Web IQ Screens. I have the language setting available inside the ctrlX PLC. How can I change the language with an PLC variable without pressing a button? I would assume it should be possible via JS. But I have no experience with JS and I need an example. Could someone help?

[webiq-sk]

In WebIQ the language of the HMI is bound to the user, not globally. We have a UI Action "setlocale (final)" which could be triggered from within a LocalScript when the corresponding item changes. However, changing the locale in WebIQ always forces a reload of the HMI which is probably not what you want as a reload will show the HMI as it looks initially - so if you change the HMI from the outside like this the screen/area where the user was before that change will be lost.

Why would you want to change the language from the PLC in the first place if each WebIQ user can have its own locale?

[SchneJoe]

Thanks for your answer. As I said before, I have a third party HMI software which is showing a WebIQ screen in a frame. The HMI Software has its own language settings. If I open the screen which includes the WebIQ frame, I would like to have everything in the same language. About the automatic reload I don't mind. I have Auto Login and a screen with tabs. So I already managed that always the page, which was shown before, is also shown after a reload. I need an example how to trigger this UI action when a PLC variable changes. I am not so familiar with script programming.

[webiq-sk]

This is a short example - you can just create a new LocalScript (don't forget to add it to the HMI!) and replace the module.run() code by this block:

module.run = function (self) {
        const im            = shmi.visuals.session.ItemManager;
        const myItemHandler = im.getItemHandler();

        myItemHandler.setValue = function (value) {
            console.log("The value of the item has been set to " + value);
            if (value == 1) {
                let p = [{
                name: "notify",
                params: ["This dialog was triggered by a UI Action!", "UI Action Dialog"]
            }];
            new shmi.visuals.core.UiAction(p).execute(); // close Dialog
            }
        };

        const subscriptionToken = im.subscribeItem('SInt', myItemHandler);
        /* called when this local-script is disabled */
        self.onDisable = function () {
            self.run = false; /* from original .onDisable function of LocalScript control */
            subscriptionToken.unlisten();
        };
    };

This will show a dialog whenever the Item "SInt" changes to 1.

[bostroemc · Accepted solution]

Just to clarify the previous answer, to call the UI Action associated with language switching, change the name from "notify" to "setlocale" and set params to the appropriate locale string:

See complete script and sample output attached.

A complete listing of UI Actions is given in the documenation here.