Export translations
Views
Special page
From OpenSCADAWiki
Jump to:
navigation
,
search
Settings
Group
About
Documents
Documents/API
Documents/DAQ
Documents/FAQ
Documents/How to
Documents/How to/Build from source
Documents/How to/Crash report
Documents/How to/Create module
Documents/How to/Create multi language project
Documents/How to/Cyclic programming
Documents/How to/Debug
Documents/How to/Install
Documents/How to/Live disk
Documents/How to/Release
Documents/How to/Transferring project configuration
Documents/How to/Violations, alarms and notifications
Documents/Program manual
Documents/Quick start
Documents/Release 0.8.0
Documents/Release 0.8.0/Update10
Documents/Release 0.8.0/Update11
Documents/Release 0.8.0/Update12
Documents/Release 0.8.0/Update13
Documents/Release 0.8.0/Update14
Documents/Release 0.8.0/Update15
Documents/Release 0.8.0/Update16
Documents/Release 0.8.0/Update17
Documents/Release 0.8.0/Update18
Documents/Release 0.8.0/Update19
Documents/Release 0.8.0/Update20
Documents/Release 0.8.0/Update3
Documents/Release 0.8.0/Update4
Documents/Release 0.8.0/Update5
Documents/Release 0.8.0/Update6
Documents/Release 0.8.0/Update7
Documents/Release 0.8.0/Update8
Documents/Release 0.8.0/Update9
Documents/Release 0.9
Documents/Release 0.9/Update 7
Documents/Release 0.9/Update1
Documents/Release 0.9/Update2
Documents/Release 0.9/Update3
Documents/Release 0.9/Update4
Documents/Release 0.9/Update5
Documents/Release 0.9/Update6
Documents/Release 0.9/Updating 0.8.0 LTS
Documents/Terms
Documents/User API
Functions and demands
Home
Libs
Libs/Devices
Libs/Documents
Libs/Electrical elements
Libs/Generic list
Libs/LowLevelDevices
Libs/Main
Libs/Main graphical elements
Libs/Mnemo elements
Libs/Prescriptions
Libs/Regulation elements
Libs/Service procedures
Libs/Technological apparatuses
Modules
Modules/BFN
Modules/BlockCalc
Modules/Comedi
Modules/DAQGate
Modules/DBArch
Modules/DBF
Modules/DBGate
Modules/DCON
Modules/DiamondBoards
Modules/FireBird
Modules/FLibComplex1
Modules/FLibMath
Modules/FLibSYS
Modules/FSArch
Modules/GPIO
Modules/HTTP
Modules/ICP DAS
Modules/JavaLikeCalc
Modules/LDAP
Modules/LogicLev
Modules/ModBus
Modules/MySQL
Modules/OPC UA
Modules/PostgreSQL
Modules/QTCfg
Modules/QTStarter
Modules/SelfSystem
Modules/Serial
Modules/Siemens
Modules/SMH2Gi
Modules/SNMP
Modules/Sockets
Modules/SoundCard
Modules/SQLite
Modules/SSL
Modules/System
Modules/SystemTests
Modules/UserProtocol
Modules/VCAEngine
Modules/Vision
Modules/WebCfg
Modules/WebCfgD
Modules/WebUser
Modules/WebVision
Sub-projects
Sub-projects/Automatic Builder of OpenSCADA
Sub-projects/Automation Linux distributive
Sub-projects/Embedding and PLC
Sub-projects/Server
Sub-projects/VCA
User:RomanSavochenko
Using
Using/HouseSpirit
Using/Kramatorsk Ball Mills
Using/Kramatorsk Water
Using/Model AGLKS
Using/Model Boiler
Using/OpenWrt TELEOFIS RTU968
Using/Yaroslavskij broiler
Works
Works/Road map
Works/Technical Support
Works/Technical Support/Agreement
Works/To do
Language
aa - Afar
ab - Abkhazian
ace - Achinese
ady - Adyghe
ady-cyrl - адыгабзэ
aeb - Tunisian Arabic
aeb-arab - تونسي
aeb-latn - Tûnsî
af - Afrikaans
ak - Akan
aln - Gheg Albanian
am - Amharic
an - Aragonese
ang - Old English
anp - Angika
ar - Arabic
arc - Aramaic
arn - Mapuche
arq - Algerian Arabic
ary - Moroccan Arabic
arz - Egyptian Arabic
as - Assamese
ase - American Sign Language
ast - Asturian
av - Avaric
avk - Kotava
awa - Awadhi
ay - Aymara
az - Azerbaijani
azb - تۆرکجه
ba - Bashkir
bar - Bavarian
bbc - Batak Toba
bbc-latn - Batak Toba
bcc - Southern Balochi
bcl - Bikol Central
be - Belarusian
be-tarask - Belarusian (Taraškievica orthography)
bg - Bulgarian
bgn - Western Balochi
bho - Bhojpuri
bi - Bislama
bjn - Banjar
bm - Bambara
bn - Bengali
bo - Tibetan
bpy - Bishnupriya
bqi - Bakhtiari
br - Breton
brh - Brahui
bs - Bosnian
bto - Iriga Bicolano
bug - Buginese
bxr - буряад
ca - Catalan
cbk-zam - Chavacano de Zamboanga
cdo - Min Dong Chinese
ce - Chechen
ceb - Cebuano
ch - Chamorro
cho - Choctaw
chr - Cherokee
chy - Cheyenne
ckb - Central Kurdish
co - Corsican
cps - Capiznon
cr - Cree
crh - Crimean Turkish
crh-cyrl - Crimean Turkish (Cyrillic script)
crh-latn - Crimean Turkish (Latin script)
cs - Czech
csb - Kashubian
cu - Church Slavic
cv - Chuvash
cy - Welsh
da - Danish
de - German
de-at - Austrian German
de-ch - Swiss High German
de-formal - German (formal address)
diq - Zazaki
dsb - Lower Sorbian
dtp - Central Dusun
dty - डोटेली
dv - Divehi
dz - Dzongkha
ee - Ewe
egl - Emilian
el - Greek
eml - Emiliano-Romagnolo
en - English
en-ca - Canadian English
en-gb - British English
eo - Esperanto
es - Spanish
et - Estonian
eu - Basque
ext - Extremaduran
fa - Persian
ff - Fulah
fi - Finnish
fit - Tornedalen Finnish
fj - Fijian
fo - Faroese
fr - French
frc - Cajun French
frp - Arpitan
frr - Northern Frisian
fur - Friulian
fy - Western Frisian
ga - Irish
gag - Gagauz
gan - Gan Chinese
gan-hans - Simplified Gan script
gan-hant - Traditional Gan script
gd - Scottish Gaelic
gl - Galician
glk - Gilaki
gn - Guarani
gom - Goan Konkani
gom-deva - Goan Konkani (Devanagari script)
gom-latn - Goan Konkani (Latin script)
got - Gothic
grc - Ancient Greek
gsw - Swiss German
gu - Gujarati
gv - Manx
ha - Hausa
hak - Hakka Chinese
haw - Hawaiian
he - Hebrew
hi - Hindi
hif - Fiji Hindi
hif-latn - Fiji Hindi (Latin script)
hil - Hiligaynon
ho - Hiri Motu
hr - Croatian
hrx - Hunsrik
hsb - Upper Sorbian
ht - Haitian Creole
hu - Hungarian
hy - Armenian
hz - Herero
ia - Interlingua
id - Indonesian
ie - Interlingue
ig - Igbo
ii - Sichuan Yi
ik - Inupiaq
ike-cans - Eastern Canadian (Aboriginal syllabics)
ike-latn - Eastern Canadian (Latin script)
ilo - Iloko
inh - Ingush
io - Ido
is - Icelandic
it - Italian
iu - Inuktitut
ja - Japanese
jam - Jamaican Creole English
jbo - Lojban
jut - Jutish
jv - Javanese
ka - Georgian
kaa - Kara-Kalpak
kab - Kabyle
kbd - Kabardian
kbd-cyrl - Адыгэбзэ
kg - Kongo
khw - Khowar
ki - Kikuyu
kiu - Kirmanjki
kj - Kuanyama
kk - Kazakh
kk-arab - Kazakh (Arabic script)
kk-cn - Kazakh (China)
kk-cyrl - Kazakh (Cyrillic script)
kk-kz - Kazakh (Kazakhstan)
kk-latn - Kazakh (Latin script)
kk-tr - Kazakh (Turkey)
kl - Kalaallisut
km - Khmer
kn - Kannada
ko - Korean
ko-kp - 한국어 (조선)
koi - Komi-Permyak
kr - Kanuri
krc - Karachay-Balkar
kri - Krio
krj - Kinaray-a
ks - Kashmiri
ks-arab - Kashmiri (Arabic script)
ks-deva - Kashmiri (Devanagari script)
ksh - Colognian
ku - Kurdish
ku-arab - كوردي (عەرەبی)
ku-latn - Kurdish (Latin script)
kv - Komi
kw - Cornish
ky - Kyrgyz
la - Latin
lad - Ladino
lb - Luxembourgish
lbe - лакку
lez - Lezghian
lfn - Lingua Franca Nova
lg - Ganda
li - Limburgish
lij - Ligurian
liv - Livonian
lmo - Lombard
ln - Lingala
lo - Lao
loz - Lozi
lrc - Northern Luri
lt - Lithuanian
ltg - Latgalian
lus - Mizo
luz - Southern Luri
lv - Latvian
lzh - Literary Chinese
lzz - Laz
mai - Maithili
map-bms - Basa Banyumasan
mdf - Moksha
mg - Malagasy
mh - Marshallese
mhr - Eastern Mari
mi - Maori
min - Minangkabau
mk - Macedonian
ml - Malayalam
mn - Mongolian
mo - молдовеняскэ
mr - Marathi
mrj - Western Mari
ms - Malay
mt - Maltese
mus - Creek
mwl - Mirandese
my - Burmese
myv - Erzya
mzn - Mazanderani
na - Nauru
nah - Nāhuatl
nan - Min Nan Chinese
nap - Neapolitan
nb - Norwegian Bokmål
nds - Low German
nds-nl - Low Saxon
ne - Nepali
new - Newari
ng - Ndonga
niu - Niuean
nl - Dutch
nl-informal - Nederlands (informeel)
nn - Norwegian Nynorsk
nov - Novial
nrm - Nouormand
nso - Northern Sotho
nv - Navajo
ny - Nyanja
oc - Occitan
olo - Livvi-Karelian
om - Oromo
or - Oriya
os - Ossetic
pa - Punjabi
pag - Pangasinan
pam - Pampanga
pap - Papiamento
pcd - Picard
pdc - Pennsylvania German
pdt - Plautdietsch
pfl - Palatine German
pi - Pali
pih - Norfuk / Pitkern
pl - Polish
pms - Piedmontese
pnb - Western Punjabi
pnt - Pontic
prg - Prussian
ps - Pashto
pt - Portuguese
pt-br - Brazilian Portuguese
qu - Quechua
qug - Chimborazo Highland Quichua
rgn - Romagnol
rif - Riffian
rm - Romansh
rmy - Romani
rn - Rundi
ro - Romanian
roa-tara - tarandíne
ru - Russian
rue - Rusyn
rup - Aromanian
ruq - Megleno-Romanian
ruq-cyrl - Megleno-Romanian (Cyrillic script)
ruq-latn - Megleno-Romanian (Latin script)
rw - Kinyarwanda
sa - Sanskrit
sah - Sakha
sat - Santali
sc - Sardinian
scn - Sicilian
sco - Scots
sd - Sindhi
sdc - Sassarese Sardinian
sdh - Southern Kurdish
se - Northern Sami
sei - Seri
ses - Koyraboro Senni
sg - Sango
sgs - Samogitian
sh - Serbo-Croatian
shi - Tachelhit
shi-latn - Tašlḥiyt
shi-tfng - ⵜⴰⵛⵍⵃⵉⵜ
si - Sinhala
sk - Slovak
sl - Slovenian
sli - Lower Silesian
sm - Samoan
sma - Southern Sami
sn - Shona
so - Somali
sq - Albanian
sr - Serbian
sr-ec - Serbian (Cyrillic script)
sr-el - Serbian (Latin script)
srn - Sranan Tongo
ss - Swati
st - Southern Sotho
stq - Saterland Frisian
su - Sundanese
sv - Swedish
sw - Swahili
szl - Silesian
ta - Tamil
tcy - Tulu
te - Telugu
tet - Tetum
tg - Tajik
tg-cyrl - Tajik (Cyrillic script)
tg-latn - Tajik (Latin script)
th - Thai
ti - Tigrinya
tk - Turkmen
tl - Tagalog
tly - Talysh
tn - Tswana
to - Tongan
tokipona - Toki Pona
tpi - Tok Pisin
tr - Turkish
tru - Turoyo
ts - Tsonga
tt - Tatar
tt-cyrl - Tatar (Cyrillic script)
tt-latn - Tatar (Latin script)
tum - Tumbuka
tw - Twi
ty - Tahitian
tyv - Tuvinian
tzm - Central Atlas Tamazight
udm - Udmurt
ug - Uyghur
ug-arab - Uyghur (Arabic script)
ug-latn - Uyghur (Latin script)
uk - Ukrainian
ur - Urdu
uz - Uzbek
uz-cyrl - ўзбекча
uz-latn - oʻzbekcha
ve - Venda
vec - Venetian
vep - Veps
vi - Vietnamese
vls - West Flemish
vmf - Main-Franconian
vo - Volapük
vot - Votic
vro - Võro
wa - Walloon
war - Waray
wo - Wolof
wuu - Wu Chinese
xal - Kalmyk
xh - Xhosa
xmf - Mingrelian
yi - Yiddish
yo - Yoruba
yue - Cantonese
za - Zhuang
zea - Zeelandic
zh - Chinese
zh-cn - Chinese (China)
zh-hans - Simplified Chinese
zh-hant - Traditional Chinese
zh-hk - Chinese (Hong Kong)
zh-mo - 中文(澳門)
zh-my - 中文(马来西亚)
zh-sg - Chinese (Singapore)
zh-tw - Chinese (Taiwan)
zu - Zulu
qqq - Message documentation
Format
Export for off-line translation
Export in native format
{{DISPLAYTITLE:Libs/Documents}}<languages/> {| class="wikitable" |- ! Name !! Version !! License !! Source !! Languages !! Author !! Icon !! Description |- <section begin=info /> | [[Special:MyLanguage/Libs/Documents|Reports' and documents' library]] | 2.0, 2.1 || GPLv2 || OscadaLibs.db ([http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/OscadaLibs.sql SQL], [[:File:OscadaLibs.db.gz|GZip]]) > DAQ.JavaLikeCalc.doc<br/> vcaBase.db ([http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/vcaBase.sql SQL], [[:File:vcaBase.db.gz|GZip]]) > VCA.wlb_doc | en, uk, ru <section end=info /> | [[User:RomanSavochenko|Roman Savochenko]] || [[file:LibDocuments.png]] | Provides the combined library of the reports, documents and related functions of common and the industrial automation. * '''Founded:''' January 2008 * '''Initially created, for the functions:''' in [http://wiki.oscada.org/HomePageEn/Using/APIFunctionLibs/LibDoc the old Wiki] * '''Used by:''' [[Special:MyLanguage/Using|most projects on OpenSCADA]] * '''[[Special:MyLanguage/Works/To_do|To Do]]:''' <section begin=ToDo /> :- expand the document "[[Special:MyLanguage/Libs/Documents#docRepYear|Year report of the month values]]" in processing the manual entered counters overrun; :- expand the document function "[[Special:MyLanguage/Libs/Documents#diagram|Diagram]]" in support the bar graphs. <section end=ToDo /> |} The library is created to provide report and document elements-frames of the user interface and it contains graphic elements, often need when forming the user interface of the automation of technological and common processes. The library is mostly built on the basis [[Special:MyLanguage/Modules/VCAEngine#Document|the primitive "Document"]] and the internal programming language [[Special:MyLanguage/Modules/JavaLikeCalc|JavaLikeCalc]], for the related functions also. The element's names and their parameters are available in languages: English, Ukrainian and mRussian. Their source code wrote in human-language independent mode with calls for the translations by the function ''tr()'' and the message's translation also allowed for English, Ukrainian and mRussian. == Documents == Contains elements-frames of the documents of the template and end types, what intended to be placed in the "Documents" part (the type of view) of the project tree of the pages, built on [[Special:MyLanguage/Libs/Main_graphical_elements#RootPgSo|the concept of the signal objects of the root page "RootPgSo"]]. However, they may be located as separate entities or as a part of your own concept of the page management, but it should be take in account that frames often refer and call [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the panel of documents]]! For connection the library part to a project of the OpenSCADA station you can obtain the database file as: * supplied with a ready and proper package of the Linux distribution like to "openscada-libdb-vca", "openscada-LibDB.VCA"; * directly taken for most actual one from [http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/vcaBase.sql the subversion repository] and converted to the DB SQLite file in the way: <syntaxhighlight lang="BASH" style="margin-left: 15px"> wget http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/vcaBase.sql sqlite3 -init vcaBase.sql vcaBase.db .exit </syntaxhighlight> * downloaded for [[:File:vcaBase.db.gz|the one attached here]]. This obtained file next you can place into the project directory of the station and create the database object for the DB module "SQLite", registering the database file in the configuration. {| class="wikitable" <section begin=doc /> | {{Anch|doc|<h3>Document - archival ([[Special:MyLanguage/Libs/Documents#doc|doc]])</h3>}} || 1.2 || GPLv2 || * || en, uk, ru <section end=doc /> | [[User:RomanSavochenko|Roman Savochenko]] |} The frame, shown in Figure 1.1, is a template of documents of the archive type and it is provided as an example and for building own archive documents on it basis. The main specific of that document type is the periodic generating on the VCA-session level (in the background) and placing the final and ready to view documents to an archive, the VCA-project's session DB-table "prj_{ProjID}_ses". The main advantage of this document type is the lowest load on CPU during the generation, which can be multi-step one during the main generation period, and the fast view, which involves simply opening the ready documents from the archive. But this document type has a significant disadvantage, which is the constant execution of single project session in the background and the absence of which leads to the omission of the documents generation in the archive. [[file:at.png]] Therefore, documents of this type are appropriated to use on the stationary AWPs of the operators, even if it is a reproduction from the visualisation server, and are useless in the WEB-interface! [[file:LibDocuments_doc.png|center|frame|Fig.1.1. The "Document - archival" frame in the development mode.]] {{CntHdr|Using — development}} The frame can only be used as a basis for creating your own archival type documents, for which you should it copy or inherit, by selecting the appropriate option in the copy dialog. Next, you need to edit the document template, in the appropriate attribute, according to the needs of your document, and write your own procedure for periodically and step-by-step formatting of the documents with closing to the archive, a sample of which can be obtained from the final documents based on this. {| class="wikitable" <section begin=docRepDay /> | {{Anch|docRepDay|<h4>Day report of the hour-averaged values ([[Special:MyLanguage/Libs/Documents#docRepDay|docRepDay]])</h4>}} | 3.2 || GPLv2 || * || en, uk, ru <section end=docRepDay /> | [[User:RomanSavochenko|Roman Savochenko]] || -1 ms (parent) |} The document, shown in Figure 1.1.1, is provided for generating a day report of the hour-averaged values in view of the trends diagram and the data table. The document is initially the archival type but in time it is made dynamic also, so, depending from the execution mode, you can whether select a ready document from the archive or specify the data time and depth. The document commonly uses and represents the representative structure of the DAQ-template "[[Special:MyLanguage/Libs/Main#anUnif|Analog signal]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchVals|the value archives]] of the DAQ-parameters. Working in the primary archival mode performed with the 5 minutes period, when during an hour an one record-row data is formed. The last one record-row is closed at the 5 minute of a new hour (14:05 for example) and a new one record-row is started. Whole and complete document is archived at the 3 minute of the "Report hour (''repHour'')" of the next day (09:03 for example). * '''Sponsored for the dynamization by''': BLUE STAR GROUP Ltd and Vinnica Poultry Farm [[file:LibDocuments_docRepDay.png|center|frame|Fig.1.1.1. The "Day report of the hour-averaged values" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. To each document can be connected up to ten parameters, setting the links. Items, for which there are not set the links, will be hidden at runtime. [[file:at.png]] To each document can be set: * the "Archive length ('''n''')" attribute in need value of the document archive size or in 0 for the dynamic mode; * the "Archiver ('''arch''')" attribute in need archiver that maintains the specified parameters; you must not use archivers with worse at one minute quality; * the "Report hour ('''repHour''')" attribute in the document report hour — start hour of the day; * the "Enable graph ('''enGraph''')" attribute for enable/disable the graph; * the "Title ('''title''')" attribute in the document specific title. {{CntHdr|Using — runtime}} In the runtime mode, the items, for which links have been set, are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Configuration !! Configuration template !! Description |- | n || Archive length, 0 for the dynamic mode || Integer || Constant || || Setting the archive size in 0 you switch the document mode to the dynamic type, by default 100. |- | repHour || Report hour || Integer || Constant || || The hour which means as the report start — the day start, by default 9. |- | colspan="6" | ''Document widget (doc)'' |- | arch || Archiver || String || Constant || || Values archiver, by default and preferable to use one-minute archiver "FSArch.1m". |- | title || Title || String || Constant || || Title of the report. |- | enGraph || Enable graph || Boolean || Constant || || Enabled by default. |- | colspan="6" | ''Parameter {n} from 1 to 10.'' |- | p{n}name || Parameter {n}: name || String || Input link || Parameter{n}|NAME || Name of the parameter in the table header. |- | p{n}var || Parameter {n}: variable || Address || Input link || Parameter{n}|var || Address to the parameter attribute with the value archive. |- | p{n}ed || Parameter {n}: dimension || String || Input link || Parameter{n}|ed || |- | p{n}prec || Parameter {n}: precision || Integer || Input link || Parameter{n}|prec || |- | p{n}cntr || Parameter {n}: is counter || Boolean || Constant || Parameter{n}|isCntr || Sets for counters for obtain the values as difference. |- | p{n}max || Parameter {n}: maximum || Address || Input link || Parameter{n}|max || Used for determining the parameter scale on the graph. |- | p{n}min || Parameter {n}: minimum || Address || Input link || Parameter{n}|min || Used for determining the parameter scale on the graph. |} {| class="wikitable" <section begin=docRepMonth /> | {{Anch|docRepMonth|<h4>Month report of the day-averaged values ([[Special:MyLanguage/Libs/Documents#docRepMonth|docRepMonth]])</h4>}} | 3.2 || GPLv2 || * || en, uk, ru <section end=docRepMonth /> | [[User:RomanSavochenko|Roman Savochenko]] || -1 ms (parent) |} The document, shown in Figure 1.1.2, is provided for generating a month report of the day-averaged values in view of the trends diagram and the data table. The document is initially the archival type but in time it is made dynamic also, so, depending from the execution mode, you can whether select a ready document from the archive or specify the data time and depth. The document commonly uses and represents the representative structure of the DAQ-template "[[Special:MyLanguage/Libs/Main#anUnif|Analog signal]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchVals|the value archives]] of the DAQ-parameters. Working in the primary archival mode performed with the 5 minutes period, when during a day an one record-row data is formed. The last one record-row is closed at the 5 minute of a new day (05 09:05 for example) and a new one record-row is started. Whole and complete document is archived at the 3 minute of the "Report hour (''repHour'')" of the next month (05 09:03 for example). * '''Sponsored for the dynamization by''': BLUE STAR GROUP Ltd [[file:LibDocuments_docRepMonth.png|center|frame|Fig.1.1.2. The "Month report of the day-averaged values" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. To each document can be connected up to ten parameters, setting the links. Items, for which there are not set the links, will be hidden at runtime. [[file:at.png]] To each document can be set: * the "Archive length ('''n''')" attribute in need value of the document archive size or in 0 for the dynamic mode; * the "Archiver ('''arch''')" attribute in need archiver that maintains the specified parameters; you must not use archivers with worse at one day quality; * the "Report hour ('''repHour''')" attribute in the document report hour — start hour of the day; * the "Enable graph ('''enGraph''')" attribute for enable/disable the graph; * the "Title ('''title''')" attribute in the document specific title. {{CntHdr|Using — runtime}} In the runtime mode, the items, for which links have been set, are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Configuration !! Configuration template !! Description |- | n || Archive length, 0 for the dynamic mode || Integer || Constant || || Setting the archive size in 0 you switch the document mode to the dynamic type, by default 100. |- | repHour || Report hour || Integer || Constant || || The hour which means as the report start — the day start, by default 9. |- | colspan="6" | ''Document widget (doc)'' |- | arch || Archiver || String || Constant || || Values archiver, by default and preferable to use one-minute archiver "FSArch.1m". |- | title || Title || String || Constant || || Title of the report. |- | enGraph || Enable graph || Boolean || Constant || || Enabled by default. |- | colspan="6" | ''Parameter {n} from 1 to 10.'' |- | p{n}name || Parameter {n}: name || String || Input link || Parameter{n}|NAME || Name of the parameter in the table header. |- | p{n}var || Parameter {n}: variable || Address || Input link || Parameter{n}|var || Address to the parameter attribute with the value archive. |- | p{n}ed || Parameter {n}: dimension || String || Input link || Parameter{n}|ed || |- | p{n}prec || Parameter {n}: precision || Integer || Input link || Parameter{n}|prec || |- | p{n}cntr || Parameter {n}: is counter || Boolean || Constant || Parameter{n}|isCntr || Sets for counters for obtain the values as difference. |- | p{n}max || Parameter {n}: maximum || Address || Input link || Parameter{n}|max || Used for determining the parameter scale on the graph. |- | p{n}min || Parameter {n}: minimum || Address || Input link || Parameter{n}|min || Used for determining the parameter scale on the graph. |} {| class="wikitable" <section begin=docDin /> | {{Anch|docDin|<h3>Document - dynamic ([[Special:MyLanguage/Libs/Documents#docDin|docDin]])</h3>}} | 1.3 || GPLv2 || * || en, uk, ru <section end=docDin /> | [[User:RomanSavochenko|Roman Savochenko]] || -2 ms (disabled) |} The frame, shown in Figure 1.2, is a template of documents of the dynamic type and it is provided as an example and for building own dynamic documents on it basis. The main specific of that document type is the synchronous generating at the requesting-opening. The main advantage of this document type is the maximal actuality of the data and the document language, for the multilingual interfaces, that is the possibility of generating for the specified date and time. But this document type has a significant disadvantage, which is the high CPU load and long time of the synchronous generation for big archival data. [[file:at.png]] Therefore, documents of this type are allowed to use on every types of the interfaces, include the WEB-interfaces, but some documents based on big archival data require for not slow processing systems! [[file:LibDocuments_docDin.png|center|frame|Fig.1.2. The "Document - dynamic" frame in the development mode.]] {{CntHdr|Using — development}} The frame can only be used as a basis for creating your own dynamic type documents, for which you should it copy or inherit, by selecting the appropriate option in the copy dialog. Next, you need to edit the document template, in the appropriate attribute, according to the needs of your document, and write your own common generation procedure, if it is not builtin into the document template. {| class="wikitable" <section begin=docRepInstVals /> | {{Anch|docRepInstVals|<h4>Instantaneous values report ([[Special:MyLanguage/Libs/Documents#docRepInstVals|docRepInstVals]])</h4>}} | 2.1 || GPLv2 || * || en, uk, ru <section end=docRepInstVals /> | [[User:RomanSavochenko|Roman Savochenko]] |} The document, shown in Figure 1.2.1, is provided for generating a report of the instantaneous values in view of the trends diagram and the data table. The document is the dynamic type, so you can specify the data time and depth. The document commonly uses and represents the representative structure of the DAQ-template "[[Special:MyLanguage/Libs/Main#anUnif|Analog signal]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchVals|the value archives]] of the DAQ-parameters. [[file:LibDocuments_docRepInstVals.png|center|frame|Fig.1.2.1. The "Instantaneous values report" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. To each document can be connected up to ten parameters, setting the links. Items, for which there are not set the links, will be hidden at runtime. The default document depth in the past is set at 10 minutes. [[file:at.png]] To each document can be set: * the "Enable graph ('''enGraph''')" attribute for enable/disable the graph; * the "Title ('''title''')" attribute in the document specific title. {{CntHdr|Using — runtime}} In the runtime mode, the items, for which links have been set, are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Configuration !! Configuration template !! Description |- | colspan="6" | ''Document widget (doc)'' |- | title || Title || String || Constant || || Title of the report. |- | enGraph || Enable graph || Boolean || Constant || || Enabled by default. |- | colspan="6" | ''Parameter {n} from 1 to 10.'' |- | p{n}name || Parameter {n}: name || String || Input link || Parameter{n}|NAME || Name of the parameter in the table header. |- | p{n}var || Parameter {n}: variable || Address || Input link || Parameter{n}|var || Address to the parameter attribute with the value archive. |- | p{n}ed || Parameter {n}: dimension || String || Input link || Parameter{n}|ed || |- | p{n}prec || Parameter {n}: precision || Integer || Input link || Parameter{n}|prec || |- | p{n}max || Parameter {n}: maximum || Address || Input link || Parameter{n}|max || Used for determining the parameter scale on the graph. |- | p{n}min || Parameter {n}: minimum || Address || Input link || Parameter{n}|min || Used for determining the parameter scale on the graph. |} {| class="wikitable" <section begin=docAlarmsRep /> | {{Anch|docAlarmsRep|<h4>Protocol of violations ([[Special:MyLanguage/Libs/Documents#docAlarmsRep|docAlarmsRep]])</h4>}} | 1.7 || GPLv2 || * || en, uk, ru <section end=docAlarmsRep /> | [[User:RomanSavochenko|Roman Savochenko]] || -2 ms (disabled) |} The document, shown in Figure 1.2.2, is provided for generating a report of the violations. The document is the dynamic type, so you can specify the data time and depth. The document commonly uses and represents the messages structure "[[Special:MyLanguage/Documents/Program_manual#ArchMess|Violations]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchMess|the message archive]]. [[file:LibDocuments_docAlarmsRep.png|center|frame|Fig.1.2.2. The "Protocol of violations" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. To each document can be set own messages level and category of the processed violations in the attribute "Message category ('''messCat''')", which is the generic one by default "1:al*:*" and can be specified by the data sources. The default document depth in the past is set at 1 day. {{CntHdr|Using — runtime}} In the runtime mode, the specified violation messages are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Description |- | messCat || Message category || String || The requested violation messages level and category, by default "1:al*:*". |} {| class="wikitable" <section begin=docUsersSet /> | {{Anch|docUsersSet|<h4>Protocol of interruptions ([[Special:MyLanguage/Libs/Documents#docUsersSet|docUsersSet]])</h4>}} | 1.8 || GPLv2 || * || en, uk, ru <section end=docUsersSet /> | [[User:RomanSavochenko|Roman Savochenko]] |} The document, shown in Figure 1.2.3, is provided for generating a report of the user interruptions. The document is the dynamic type, so you can specify the data time and depth. The document commonly uses and represents the messages structure "[[Special:MyLanguage/Documents/Program_manual#ArchMess|User-operator actions]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchMess|the message archive]]. [[file:LibDocuments_docUsersSet.png|center|frame|Fig.1.2.3. The "Protocol of interruptions" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page, and should therefore be placed directly in the project's tree. The document does not mean any configurations due to the interruption messages are common. The default document depth in the past is set at 1 day. {{CntHdr|Using — runtime}} In the runtime mode, the user interruption messages are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Description |- | messCat || Message category || String || The requested messages level and category, by default "<nowiki>2:/(^|.*:)OP*/</nowiki>". |} {| class="wikitable" <section begin=docMessRep /> | {{Anch|docMessRep|<h4>Protocol of messages ([[Special:MyLanguage/Libs/Documents#docMessRep|docMessRep]])</h4>}} || 1.5 || GPLv2 || * || en, uk, ru <section end=docMessRep /> | [[User:RomanSavochenko|Roman Savochenko]] |} The document, shown in Figure 1.2.4, is provided for generating a report of [[Special:MyLanguage/Documents/Program_manual#ArchMess|different sort messages]] together, including: "Violations", "User-operator actions" and "System". The document is the dynamic type, so you can specify the data time and depth. The document so commonly uses and represents [[Special:MyLanguage/Documents/Program_manual#ArchMess|the messages structures]]: "Violations", "User-operator actions" and "System". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchMess|the message archive]]. The document also provides a simple filtering for selected criteria: "Disabled", "Date and time (dttm)", "Level (lev)", "Parameter (prm)", "Description (dscr)", "Value (alrm)". * '''Sponsored by:''' Ustijancev Michael [[file:LibDocuments_docMessRep.png|center|frame|Fig.1.2.4. The "Protocol of messages" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. [[file:at.png]] To each document can be set own level and category of the processed messages in the attribute "Message category ('''messCat''')", which is the generic one by default "1:/^(al|OP|/sub_UI/mod_VCAEngine)/" and can be specified for yourself. Also you can specify the only used archivers by setting the attribute "Archivers list ('''archLs''')". The default document depth in the past is set at 1 day. {{CntHdr|Using — runtime}} In the runtime mode, the specified messages are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. Selecting a filtering criteria and entering text required to presence, the user can see only needed messages. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Description |- | messCat || Message category || String || The requested messages level and category, by default "1:/^(al|OP|/sub_UI/mod_VCAEngine)/". |- | archLs || Archivers list, "{ArhMod}.{Arh}[;{ArhModN}.{ArhN}]" || String || List of message archivers from which the messages will be only requested, set empty for common access. |} {| class="wikitable" <section begin=docRep2WorkSh /> | {{Anch|docRep2WorkSh|<h4>Report of two working shifts ([[Special:MyLanguage/Libs/Documents#docRep2WorkSh|docRep2WorkSh]])</h4>}} || 2.0 || GPLv2 || * || en, uk, ru <section end=docRep2WorkSh /> | [[User:RomanSavochenko|Roman Savochenko]] |} The document, shown in Figure 1.2.5, is provided for generating a report of the hour values of up to 10 parameters for two working shift of day with the result sum for flows and related parameters. The document is the dynamic type, so you can specify the data time and depth (fixed). The document commonly uses and represents the representative structure of the DAQ-template "[[Special:MyLanguage/Libs/Main#anUnif|Analog signal]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchVals|the value archives]] of the DAQ-parameters. * '''Sponsored by:''' [http://diyaorg.dp.ua DIYA Ltd] [[file:LibDocuments_docRep2WorkSh.png|center|frame|Fig.1.2.5. The "Report of two working shifts" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. To each document can be connected up to ten parameters, setting the links. Items, for which there are not set the links, will be hidden at runtime. [[file:at.png]] You must also specify an one-hour archiver in the "Archiver ('''arch''')" attribute that maintains the specified parameters, since this document requires such data. If the start of the first working shift is different from 8 (eighth) hours, then you must specify the required hour in the "Start hour ('''stH''') attribute. {{CntHdr|Using — runtime}} In the runtime mode, the items, for which links have been set, are displayed. Additionally you can control the display properties of documents, for what there is used [[Special:MyLanguage/Libs/Main_graphical_elements#doc_panel|the document control panel]], which can be called clicking the left mouse button in the document area. Since the document fixes the depth in history at 12 hours (one working shift), the user can only change the document time! {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Configuration !! Configuration template !! Description |- | colspan="6" | ''Document widget (doc)'' |- | stH || Start hour || Integer || Constant || || Start hour of the working shifts, from 0 to 11 hour, by default 8. |- | arch || Archiver || String || Constant || || One-hour archiver, by default "FSArch.1h". |- | colspan="6" | ''Parameter {n} from 1 to 10.'' |- | p{n}_sh || Parameter {n}: code || String || Input link || Parameter{n}|NAME || Code of the parameter in the table. |- | p{n}_nm || Parameter {n}: description || String || Input link || Parameter{n}|DESCR || Description of the parameter in the table. |- | p{n}_val || Parameter {n}: value || Address || Input link || Parameter{n}|var || Address to the parameter attribute with the value archive. |- | p{n}_ed || Parameter {n}: dimension || String || Input link || Parameter{n}|ed || |- | p{n}_prec || Parameter {n}: precision || Integer || Input link || Parameter{n}|prec || |- | p{n}_flSum || Parameter {n}: sum flag || Boolean || Constant || Parameter{n}|flSum || Sign of calculation the parameter values sum for the working shift. |} {| class="wikitable" <section begin=docRepYear /> | {{Anch|docRepYear|<h4>Year report of the month values ([[Special:MyLanguage/Libs/Documents#docRepYear|docRepYear]])</h4>}} | 1.3 || GPLv2 || * || en, uk, ru <section end=docRepYear /> | [[User:RomanSavochenko|Roman Savochenko]] || -2 ms (disabled) |} The document, shown in Figure 1.2.6, is provided for generating a year report of the month values in view of the trends diagram and the data table. The document is the dynamic type. The document commonly uses and represents the representative structure of the DAQ-template "[[Special:MyLanguage/Libs/Main#anUnif|Analog signal]]". As a data source of this document is [[Special:MyLanguage/Documents/Program_manual#ArchVals|the value archives]] of the DAQ-parameters mostly. The document first introduced the manual entry of archival values of a large measurement time interval, which in this case is a month, as an undetermined interval. This feature is of great relevance for counters that for one reason or another cannot be connected to the system directly, with continuous measurement or periodic uploading of archive parts. Determining the parameter to manual input performs by setting the constant '''isMan''' of the appropriate parameter, which enables the form elements at the top of the document under the appropriate rights ("root" or in the "ITW" group), and accessing the data for the table and trend strictly at the interval of the document — month, as well as entering them. Manually entered data is stored whether traditionally in an archive of values, with only one value recorded per representative interval, that is, with unreliable values between them; or as a separate entry with a value in the message archive, also introduced for the first time by this document: : CATEGORY: defines the source ID ''SrcID'' in the form "'''val{SrcID}'''", where: :* "val*" — the typical template-sign of a value, that can be directly used in the category filter to determine only the values in messages; :* ''SrcID'' — source identifier, what directly entered by a constant in the parameter address '''var'''. : TEXT: the parameter ''Name'' and ''Value'' in the form "'''{Name}: {Value}'''". The message archiver of [[Special:MyLanguage/Modules/FSArch|the module FSArch]] must be set for the next attributes to correct work perform together this document: set "Prevent duplicates", "Consider duplicates and prevent, for equal time, category, level" and set "Time size of the archive files" to 3660 days. [[Special:MyLanguage/Modules/DBArch|The module DBArch]] must work without such kind specific. [[file:LibDocuments_docRepYear.png|center|frame|Fig.1.2.6. The "Year report of the month values" document in the runtime mode.]] {{CntHdr|Using — development}} The document is designed to perform the role of page-template, and should therefore be placed directly in the project's tree. To each document can be connected up to ten parameters, setting the links. Items, for which there are not set the links, will be hidden at runtime. [[file:at.png]] To each document can be set: * the "Archiver ('''arch''')" attribute in required value and message archiver in the form '''{ValArch};{MessArch}''', these maintain the specified parameters; you must not use archivers with worse at one hour quality for values; * the "Enable graph ('''enGraph''')" attribute for enable/disable the graph; * the "Title ('''title''')" attribute in the document specific title. {{CntHdr|Using — runtime}} In the runtime mode, the items, for which links have been set, are displayed. The year of the document formation is available for selection on the top of this document, from the current year and for ten years in depth. With the rights ("root" or in the "ITW" group), the user can enter parameter values with the manual entry sign ('''isMan''') using the form elements above, where you can select the month, parameter and value that will be recorded immediately after confirmation and shown in the document. {{CntHdr|Linking and configuring the attributes}} {| class="wikitable" |- ! Identifier !! Name !! Type !! Configuration !! Configuration template !! Description |- | colspan="6" | ''Document widget (doc)'' |- | arch || Archiver, {ValArch};{MessArch} || String || Constant || || Value and message archiver in the form '''{ValArch};{MessArch}''', by default and preferable to use one-hour archiver "FSArch.1h". |- | title || Title || String || Constant || || Title of the report. |- | enGraph || Enable graph || Boolean || Constant || || Enabled by default. |- | depth || Depth to select, years || Integer || Constant || || Years depth allowed to select. |- | showOrigCntr || Show original counter || Boolean || Constant || || Show the original counter value near to the interval value. |- | colspan="6" | ''Parameter {n} from 1 to 10.'' |- | p{n}name || Parameter {n}: name || String || Input link || Parameter{n}|NAME || Name of the parameter in the table header. |- | p{n}var || Parameter {n}: variable || Address || Input link || Parameter{n}|var || Address to the parameter attribute with the value archive or the parameter identifier ('''val:{PrmId}''') for manually values writing at storing in the message archive. |- | p{n}ed || Parameter {n}: dimension || String || Input link || Parameter{n}|ed || |- | p{n}prec || Parameter {n}: precision || Integer || Input link || Parameter{n}|prec || |- | p{n}cntr || Parameter {n}: is counter || Boolean || Constant || Parameter{n}|isCntr || Sets for counters for obtain the values as difference. |- | p{n}max || Parameter {n}: maximum || Address || Input link || Parameter{n}|max || Used for determining the parameter scale on the graph. |- | p{n}min || Parameter {n}: minimum || Address || Input link || Parameter{n}|min || Used for determining the parameter scale on the graph. |- | p{n}isMan || Parameter {n}: is manual || Boolean || Constant || Parameter{n}|isMan || Marks this parameter as the manual input one. |} == {{Anch|ServFunc|Service related functions}} == The service functions of the frames of reports and documents are intended to perform the characteristic tasks of obtaining reporting data, for which you need to perform some verification or counting, for example, to check the validity and to summarize. Forming complex data, such as charts embedded in a document, can also be a service function. To address the library functions you can use the static call address '''DAQ.JavaLikeCalc.lib_doc.{Func}()''' or dynamic '''SYS.DAQ.JavaLikeCalc["lib_doc"]["{Func}"].call()''', '''SYS.DAQ.JavaLikeCalc["lib_doc"].{Func}()'''". Where {Func} — function identifier in the library. For connection the library part to a project of the OpenSCADA station you can obtain the database file as: * supplied with a ready and proper package of the Linux distribution like to "openscada-libdb-main", "openscada-LibDB.Main"; * directly taken for most actual one from [http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/OscadaLibs.sql the subversion repository] and converted to the DB SQLite file in the way: <syntaxhighlight lang="BASH" style="margin-left: 15px"> wget http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/OscadaLibs.sql sqlite3 -init OscadaLibs.sql OscadaLibs.db .exit </syntaxhighlight> * downloaded for [[:File:OscadaLibs.db.gz|the one attached here]]. This obtained file next you can place into the project directory of the station and create the database object for the DB module "SQLite", registering the database file in the configuration. {| class="wikitable" <section begin=getVal /> | {{Anch|getVal|<h3>Getting value from the value archive ([[Special:MyLanguage/Libs/Documents#getVal|getVal]])</h3>}} || 1.1 || GPLv2 || * || en, uk, ru <section end=getVal /> | [[User:RomanSavochenko|Roman Savochenko]] |} Query the value for the specified time (''time'':''uTime'') from the assigned archiver ''archtor'' (FSArch.1m) and issuing results with the specified number of digits ''prec'' after the dot. The function works with the DAQ-parameter attribute objects to which the archive is attached and the address ''addr'' is written to it in full path, like "/DAQ/LogicLev/gen/prm_F3/a_var". For the empty ''archtor'', the request will be made generally to everyone with the archive buffer periodicity! In the process of obtaining a value, the time of this value may be different from the requested one, if the archive is not currently present and returns the closest value, preventing why you may by setting ''strong''. When you need to get the closest valid value in a controlled way, for counters to example, you have the "tryTo" time argument to which to look for the closest valid value. The time in ''tryTo'' may be both lesser and bigger than the request time. Initially, the result is presented as a string of real value with a certain number of digits ''prec'' after the dot, and with the value "Empty" for not valid values, allowing it to be inserted into the document without further processing. However, at requiring of additional processing and specific formatting, the result can be obtained with an unformatted real value, for ''prec'' less than 0. {{CntHdr|Parameters}} {| class="wikitable" |- ! Identifier !! Parameter !! Type !! Mode !! Hidden !! Default |- | rez || Result || String || Return || false || |- | addr || Address || String || Input || false || |- | time || Time, seconds || Integer || Input || false || |- | uTime || Time, microseconds || Integer || Input || false || |- | prec || Signs after dot || Integer || Input || false || 3 |- | archtor || Archiver || String || Input || false || |- | strong || Precisely || Boolean || Input || false || 0 |- | tryTo || Try value up to, microseconds || Integer || Input || false || 0 |} {| class="wikitable" <section begin=averVal /> | {{Anch|averVal|<h3>Average value of the value archive ([[Special:MyLanguage/Libs/Documents#averVal|averVal]])</h3>}} || 1.1 || GPLv2 || * || en, uk, ru <section end=averVal /> | [[User:RomanSavochenko|Roman Savochenko]] |} Calculate the average value over a specified period of the time [''bTime''...''eTime''], for the archiver ''archtor'' (FSArch.1m) data and issuing results with the specified number of digits ''prec'' after the dot. The function works with the DAQ-parameter attribute objects to which the archive is attached and the address ''addr'' is written to it in full path, like "/DAQ/LogicLev/gen/prm_F3/a_var". For the empty ''archtor'', the request will be made generally to everyone with the archive buffer periodicity! In the process of calculation, the data in the archive is checked for validity and the value of the percentage of reliable data ''actPerc'' that participated in the result is formed. In general, you should use intermediate archivers — medium quality archivers, so that there is not too much data in a given interval to reduce performance, and that it does not have one value at all. Initially, the result is presented as a string of real value with a certain number of digits ''prec'' after the dot, and with the value "Empty" for not valid values, allowing it to be inserted into the document without further processing. However, at requiring of additional processing and specific formatting, the result can be obtained with an unformatted real value, for ''prec'' less than 0. {{CntHdr|Parameters}} {| class="wikitable" |- ! Identifier !! Parameter !! Type !! Mode !! Hidden !! Default |- | rez || Result || String || Return || false || |- | addr || Address || String || Input || false || |- | bTime || Begin time, seconds || Integer || Input || false || |- | eTime || End time, seconds || Integer || Input || false || |- | prec || Signs after dot || Integer || Input || false || 3 |- | archtor || Archiver || String || Input || false || |- | actPerc || Percent of the actual values || Real || Output || false || |} {| class="wikitable" <section begin=sumVal /> | {{Anch|sumVal|<h3>Sum values of the value archive ([[Special:MyLanguage/Libs/Documents#sumVal|sumVal]])</h3>}} || 1.1 || GPLv2 || * || en, uk, ru <section end=sumVal /> | [[User:RomanSavochenko|Roman Savochenko]] |} Calculate the summary value over a specified period of the time [''bTime''...''eTime''], for the archiver ''archtor'' (FSArch.1m) data and issuing results with the specified number of digits ''prec'' after the dot. The function works with the DAQ-parameter attribute objects to which the archive is attached and the address ''addr'' is written to it in full path, like "/DAQ/LogicLev/gen/prm_F3/a_var". For the empty ''archtor'', the request will be made generally to everyone with the archive buffer periodicity! In the process of calculation, the data in the archive is checked for validity. Initially, the result is presented as a string of real value with a certain number of digits ''prec'' after the dot, and with the value "Empty" for not valid values, allowing it to be inserted into the document without further processing. However, at requiring of additional processing and specific formatting, the result can be obtained with an unformatted real value, for ''prec'' less than 0. {{CntHdr|Parameters}} {| class="wikitable" |- ! Identifier !! Parameter !! Type !! Mode !! Hidden !! Default |- | rez || Result || String || Return || false || |- | addr || Address || String || Input || false || |- | bTime || Begin time, seconds || Integer || Input || false || |- | eTime || End time, seconds || Integer || Input || false || |- | prec || Signs after dot || Integer || Input || false || 3 |- | archtor || Archiver || String || Input || false || |} {| class="wikitable" <section begin=diagram /> | {{Anch|diagram|<h3>Diagram ([[Special:MyLanguage/Libs/Documents#diagram|diagram]])</h3>}} | 1.4 || GPLv2 || * || en, uk, ru <section end=diagram /> | [[User:RomanSavochenko|Roman Savochenko]] |} Building trends diagram to SVG, which may be builtin next to the XHTML-document, for specified period of the time [(''end''-''size'')...''end''] and from the sources ''srcs''. * '''Total complexity:''' 1.3 {{CtxDetails|HD|human-days, 1 HD — 10 hours}} * '''Sponsored by, for initial implementation on 1.0 {{CtxDetails|HD|human-days, 1 HD — 10 hours}}:''' Magomed, [https://www.savtech.ru SAVTECH] The diagram forming code is based on code of the primitive "[[Special:MyLanguage/Sub-projects/VCA#Diagram|Diagram]]" of the visualisers, and which was quite simply migrated from C++ to [[Special:MyLanguage/Modules/JavaLikeCalc|the JavaLikeCalc embedded language]]. Currently, only trends have been moved-implemented! The appearance of the diagram is determined by its dimensions ''hsz''*''vsz'' and the source SVG-template ''tmpl'', a number attributes of the root tag of which has special meaning and corresponding to the primitive "[[Special:MyLanguage/Sub-projects/VCA#Diagram|Diagram]]": * Scale: Markers: font (sclMarkFont), by default "Arial 10". * Scale: horizontal (sclHor), by default "Markers (2)" and generally provided: "No draw (0)", "Grid (1)", "Markers (2)", "Grid and markers (3)". * Scale: vertical (sclVer), by default "Grid and markers (3)" and generally provided: "No draw (0)", "Grid (1)", "Markers (2)", "Grid and markers (3)", "Grid (log) (5)", "Markers (log) (6)", "Grid and markers (log) (7)". * Scale: color (sclColor), by default "gray". * Scale: Markers: color (sclMarkColor), by default "gray". Currently, only value archives can be used as a data source, either directly to them or through the DAQ-parameter attribute with the archive. The number of data sources is not directly limited and is written in separate lines of the argument ''srcs'' in the format "'''{addr}:{min}:{max}:{color}[:{scale}[:{width}]]'''", where: * '''addr''' — address to: ** the value archive ("/Archive/va_CPULoad_load") or the DAQ-parameter attribute ("/DAQ/LogicLev/gen/F3/var"); ** the direct data in the form "'''<d s='1' aprox='1' per='1'>{p0}={pV0},{p1}={pV1},...,{pN}={pVN}</d>'''", by set the attribute "s" it will allows the period setting in seconds; "aprox" — approximate the transition from one point to another instead of the previous value to all the periodicity points from the packaging; * '''min''', '''max''' — minimum and maximum of the scale, in the scale absence ('''min''' >= '''max'''), it will be calculated from the real data; * '''color''' — colour of the trend curve; * '''scale''' — separate definition of the trend scale, by default "Global (0)" and generally provided: "Global (0)", "Markers (2)", "Grid and markers (3)", "Markers (log) (6)", "Grid and markers (log) (7)". * '''width''' — width of the trend curve, by default 2. [[file:LibDocuments_docRepInstVals.png|center|frame|Fig.2.4. The function "Diagram" default result in a XHTML-document.]] {{CntHdr|Parameters}} {| class="wikitable" |- ! Identifier !! Parameter !! Type !! Mode !! Hidden !! Default |- | res || Result || Text || Return || false || |- | end || End time, seconds || Real || Input || false || 0 |- | size || Size, seconds || Real || Input || false || 3600 |- | srcs || Sources || Text || Input || false || <pre style="white-space: pre-wrap;"> /DAQ/LogicLev/gen/F3/var:0:100:#ae77c3:2 /Archive/va_CPULoad_load:0:0:darkcyan:2 </pre> |- | hsz || Horizontal size, pixels || Integer || Input || false || 600 |- | vsz || Vertical size, pixels || Integer || Input || false || 400 |- | arch || Archiver || String || Input || false || |- | tmpl || SVG-template || Text || Input || false || <syntaxhighlight lang="XML"> <svg xmlns="http://www.w3.org/2000/svg" version="1.1" sclMarkFont="Arial 10" sclHor="2" sclVer="3" sclColor="gray" sclMarkColor="gray"> <style type="text/css"> #scVer rect { stroke: none; } #scVer text { stroke: none; } #scHor rect { stroke: none; } #scHor text { stroke: none; } #drawArea path { fill: none; } </style> <!--Draw grid and markers--> <g id="scVer" /> <g id="scHor" /> <!--Curves area --> <g id="drawArea" /> </svg> </syntaxhighlight> |}
Navigation menu
OpenSCADA
Site
Download
Old Wiki
OpenSCADA Wiki
Home
About OpenSCADA
Functions and demands
Tasks
Using
Fund
Recent changes
Random page
Search
Tools
Special pages
Printable version
MediaWiki
Help
Personal tools
English
Log in