The module <WebUser> of subsystems "User Interfaces"

Ðóññêàÿ âåðñèÿ
Óêðà¿íñüêà âåðñ³ÿ

Introduction

WebUser module provides the user with a mechanism to create Web-pages, and can process other Web-requests with the help of the internal language of OpenSCADA, usually JavaLikeCalc, without necessity of low-level programming of OpenSCADA.

Except of the module's belonging to the system OpenSCADA it also belongs and is the module of the <HTTP> transport protocol module. Actually, the WebUser call is made from Protocol.HTTP. The call is made through enhanced communication mechanism through the exported to the WebUser module functions: HttpGet() and HttpSet().

Addressing of the pages begins with the second element of the URI. It is connected with the fact that the first element of the URI is used to identify the module of user Web-interface. For example URL: http://localhost.localdomain:10002/WebUser/UserPage can be deciphered as a call of the user page "UserPage" of the Web module WebUser on the host localhost.localdomain on port 10002. In the case of absence of the second element of URI and instruction to display an index of user pages in the configuration the index of the page is generated (Figure 1).

Fig.1. Index of user pages.

The main tab of the module configuration (Fig. 2) contains the state of the module, provides the ability to select the default page and allows you to make the list of user pages.

Fig.2. Main tab of the module's configuration.

1. WEB - pages

The module provides the ability to create multiple implementations of Web-pages in the object "User page" (Fig. 3).

Fig.3. The main configuration page of the user page.

The main tab contains the basic settings of the user protocol:

• Ðàçäåë "Ñîñòîÿíèå" - ñîäåðæèò ñâîéñòâà, õàðàêòåðèçóþùèå ñîñòîÿíèå ïîëüçîâàòåëüñêîé ñòðàíèöû:
  • Âêëþ÷åí - ñîñòîÿíèå ñòðàíèöû "Âêëþ÷åíà".
  • ÁÄ - ÁÄ â êîòîðîé õðàíèòñÿ êîíôèãóðàöèÿ.
• Ðàçäåë "Êîíôèãóðàöèÿ" - íåïîñðåäñòâåííî ñîäåðæèò ïîëÿ êîíôèãóðàöèè:
  • ID - èíôîðìàöèÿ îá èäåíòèôèêàòîðå ñòðàíèöû.
  • Èìÿ - óêàçûâàåò èìÿ ñòðàíèöû.
  • Îïèñàíèå - êðàòêîå îïèñàíèå ñòðàíèöû è å¸ íàçíà÷åíèÿ.
  • Âêëþ÷àòü - óêàçûâàåò íà ñîñòîÿíèå "Âêëþ÷åí", â êîòîðîå ïåðåâîäèòü ñòðàíèöó ïðè çàãðóçêå.

Âñå çàïðîñû ê ïîëüçîâàòåëüñêèì ñòðàíèöàì íàïðàâëÿþòñÿ â ïðîöåäóðó îáðàáîòêè çàïðîñîâ ïîëüçîâàòåëüñêîé ñòðàíèöû, êîòîðàÿ ïðåäñòàâëåíà íà âêëàäêå "Ïðîãðàììà" îáúåêòà ñòðàíèöû ïîëüçîâàòåëÿ (ðèñ.4).

Ðèñ.4. Âêëàäêà "Ïðîãðàììà" îáúåêòà ïîëüçîâàòåëüñêîé ñòðàíèöû.

Âêëàäêà ïðîöåäóðû îáðàáîòêè çàïðîñîâ ê ïîëüçîâàòåëüñêîé ñòðàíèöå ñîäåðæèò ïîëå äëÿ âûáîðà âíóòðåííåãî ÿçûêà ïðîãðàììèðîâàíèÿ OpenSCADA è ïîëå ââîäà òåêñòà ïðîöåäóðû îáðàáîòêè.

Äëÿ ïðîöåäóðû îáðàáîòêè ïðåäîïðåäåëåíû ñëåäóþùèå ïåðåìåííûå îáìåíà:

• rez - ðåçóëüòàò îáðàáîòêè (ïî óìîë÷àíèþ - "200 OK");
• HTTPreq - ìåòîä HTTP çàïðîñà (GET,POST);
• url - URI çàïðîñà;
• page - ñîäåðæèìîå ñòðàíèöû Get/Post, êàê äëÿ çàïðîñà òàê è äëÿ îòâåòà;
• sender - îòïðàâèòåëü çàïðîñà;
• user - àóòåíòèôèöèðîâàííûé ïîëüçîâàòåëü;
• HTTPvars - HTTP ïåðåìåííûå â Object;
• URLprms - ïàðàìåòðû URL â Object;
• cnts - ýëåìåíòû ñîäåðæèìîãî äëÿ POST â Array<XMLNodeObj>.

Îáùèé ñöåíàðèé çàïðîñà ïîëüçîâàòåëüñêîé ñòðàíèöû:

• Âíåøíÿÿ ñåòåâàÿ ñòàíöèÿ ôîðìèðóåò HTTP çàïðîñ ñ URI âèäà "/WebUser/<UserPage>" êîòîðûé ïîïàäàåò íà òðàíñïîðò OpenSCADA ñ çíà÷åíèåì ïîëÿ êîíôèãóðàöèè "Ïðîòîêîë" ðàâíîãî "HTTP".
• Òðàíñïîðò íàïðàâëÿåò çàïðîñ íà ìîäóëü òðàíñïîðòíîãî ïðîòîêîëà Protocol.HTTP.
• Ìîäóëü òðàíñïîðòíîãî ïðîòîêîëà, â ñîîòâåòñòâèè ñ ïåðâûì ýëåìåíòîì URI, íàïðàâëÿåò çàïðîñ äàííîìó ìîäóëü.
• Äàííûé ìîäóëü âûáèðàåò îáúåêò ñòðàíèöû ïîëüçîâàòåëÿ, êîòîðàÿ óêàçàíà âî âòîðîì ýëåìåíòå URI.
• Âûïîëíÿåòñÿ èíèöèàëèçàöèÿ ïåðåìåííûõ HTTP-ïðîòîêîëà äëÿ ïðîöåäóðû ñòðàíèöû:
  • HTTPreq - óñòàíàâëèâàåòñÿ â çíà÷åíèå ñòðîêè "GET" èëè "POST", â çàâèñèìîñòè îò òèïà çàïðîñà;
  • url - àäðåñ çàïðàøèâàåìîãî ðåñóðñà (URI);
  • page - ñîäåðæèìîå ïåðåäàâàåìîé ñòðàíèöû äëÿ ìåòîäà "POST";
  • sender - àäðåñ îòïðàâèòåëÿ çàïðîñà;
  • user - àäðåñ àóòåíòèôèöèðîâàííîãî ïîëüçîâàòåëÿ, åñëè àóòåíòèôèêàöèÿ èìåëà ìåñòî;
  • HTTPvars - ðàçîáðàííûé ïåðå÷åíü ïåðåìåííûõ ïðîòîêîëà HTTP â âèäå ñâîéñòâ îáúåêòà;
  • URLprms - ðàçîáðàííûé ïåðå÷åíü ïàðàìåòðîâ URL â âèäå ñâîéñòâ îáúåêòà;
  • cnts - ðàçîáðàííûå ýëåìåíòû ñîäåðæèìîãî äëÿ POST â Array<XMLNodeObj>, ñ ñîäåðæèìûì ýëåìåíòîâ â òåêñòå è ñâîéñòâàìè â àòðèáóòàõ XMLNodeObj.
• Âûçîâ ïðîöåäóðû íà èñïîëíåíèå, êîòîðàÿ îáðàáîòàâ çàïðîñ ôîðìèðóåò ñîäåðæèìîå ñòðàíèöû â "page" è ðåçóëüòàò çàïðîñà â "rez".
• Â çàâåðøåíèè ôîðìèðóåòñÿ îòâåò ñ êîäîì âîçâðàòà HTTP èç "rez" è ñîäåðæèìûì èç "page".

Ññûëêè