SBC Saia PCD® Supervisor V3.0 - Station Templates Owner's manual

Brand: SBC

Model: Saia PCD® Supervisor V3.0 - Station Templates

Type: Owner's manual

Saia Burgess Controls

| 1

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

Supervisor Device Template

für Saia PCD

Supervisor

Software Handbook

0 Contents

0 Contents ..............................................................................................................................1

1. Document version ..............................................................................................................2

2. Description ..........................................................................................................................2

3. System requirements .........................................................................................................2

4. Installation ..........................................................................................................................3

4.1 Create a new project using the device template ................................................................3

4.2 Incorporate the device template in an existing project ......................................................6

5. Conguration ......................................................................................................................8

5.1 Congurationles ..............................................................................................................8

5.2 Usernavlemenu .............................................................................................................9

5.3 Navlesystem ..................................................................................................................11

6. Translation of the standard texts ......................................................................................14

6.1 Specialmodicationstothemenu. ....................................................................................14

7. Debugging ...........................................................................................................................15

Page

Saia Burgess Controls

2 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

2. Description

ThedevicetemplateisaHTMLtemplatethatrepresentsahomepagewithafreelycongurablemenuin

whichallpossibleviewsaswellasPXpagesandHTMLpagesareintegratedbythesupervisor.Inaddi-

tion,alarmscanbedisplayedaccordingtopriorities.

Alarmlistsarealreadydenedasexamplesforthispurpose.

3. System requirements

Test environment list: Equipment/software

• Supervisor 2.1 | Niagara 4.8.0.110

• Browser:

◦ Google Chrome Version 79.0.3945.88 (64 Bit)

◦ Firefox Version 71.0 (64 Bit)

◦ EDGE 42.17134.1098.0

• Windows 10

1. Document version

Date Version From Description

2020-04-07 ENG01 M.Egner Translated from German version GER01

2020-05-14 ENG02 M.E. & M. Habenicht New hints in chapter 5.2

Saia Burgess Controls

| 3

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

4. Installation

Therearetwowaystousethetemplate.Theseareexplainedhere.

4.1 Createanewprojectusingthedevicetemplate

Thetemplateitselfisaready-madeprojectandcanthereforeeasilybeuseddirectly.

Tobeabletouseit,copythe"sbcDeviceTemplate21vX_X_X"folderfromthezipletothefollowing

(UserHome)directory:"C:\Users\MyUserName\Niagara4.8\SBC\stations"

Start the supervisor and open the platform

Thengotothe"StationCopier":

SelecttheprojectintheStationCopierandcopyitontotheplatform

Saia Burgess Controls

4 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

Firstenterthepassphrase"SaiaPCD@1978"andthenclickNext.

Inthesubsequentwindowyoucanalsorenamethestationdirectly.

Then click Next

Saia Burgess Controls

| 5

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

Thenselecttheoptionshownsothateverythingwillbecopied.

Then click Next

Setthestartoptionsthewayyouneedthem.

ThenclickNextandnallyDone

Saia Burgess Controls

6 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

4.2 Incorporatethedevicetemplateinanexistingproject

Everythingcanbetransferreddirectlytoarunningstation.

Copythe"sbcDevice"folderfromthe"..\sbcDeviceTemplate21vX_X_X\shared\"foldertothesystempath

foryourstation:"C:\ProgramData\Niagara4.8\SBC\stations\IhreStation\shared\"

The"sbcDevice"folderisthenfoundinthestationunderles(updateifnecessary):

Saia Burgess Controls

| 7

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

Toenableeverythingtobeused,themain.navlemustbespeciedforeveryuserinthe"UserService":

Inaddition,itisalsopossibletospecifythedateformatinthetemplate,whichlaterdeneshowthetime

and date are represented.

The main.nav transforms the index.html into the start page with the appropriate view:

Saia Burgess Controls

8 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

5. Conguration

5.1 Congurationles

Anavlemustbecreatedforeachuserinthe"users"and"system"folders.

The names used must correspond to the user names (case-sensitive)!

Thismeansthattheentiretemplatecanbecustomizedforeachuserand,ifnecessary,alsoinother

languages.

The default.nav can be used as a template.

! If the user-specic nav le is missing, the default.nav le is used!

Saia Burgess Controls

| 9

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

5.2 Usernavlemenu

TheentiremenuisdenedinthenavleunderUsersaswhattheuserisintendedtosee

Thestructureandclassicationoftheusernavlecanbeadaptedasrequired.

Therstentryisalwaysthehomepageinthemenuandhasnosubmenus.

Thestructureoftheentriesunder"Start"denesthehierarchicalstructureofthemenubelow.

There can be up to four levels!

1. mainMenu

2. subMenu

3. subSubMenu

4. Pages

Saia Burgess Controls

10 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

AsusualforallnavlesinNiagara,everythingcanbelinkedhere!

Linkscanalsocontainanadditional"view"entry(e.g.|view:alarm:DatabaseMaintenance)

Starting with

version 1.0.4

ORD’s in the User-Nav-File, can now contain “?stationName”, which can be

replacedbythestationname(sbcDeviceTemplateXXvX_X_X).

Forexamplehistory:“/?stationName/AuditHistory”

Attention,

for versions

before 1.0.4

LinksforAuditHistoryorLogHistorymustbeadjustedwhenrenamingthe

device,becausetheycontainthedevicename!

Starting with

version 0.8.4

“|view:? fullScreen = false” or “?fullscreen = false”canalsobespeciedin

thenavle,thusmakingthenavtreevisible!

Saia Burgess Controls

| 11

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

5.3 Navlesystem

Allotherpointsofthetemplatearedenedinthesystemle.

Thestructureorhierarchymustnotbechanged,asotherwisethetemplatewillnolongerwork.

Staring with

version 0.9.6

The system nav le no longer includes the entry for „header/User“ or for „navi-

gation“.

No compatibility with versions ≤ 0.9.5; this needs to be modied (deleted) as

necessary!

Thetexteditorisneededforsomespecialchanges,becausetheselectionwindowofthenavleeditor

does not accept all entries.

Saia Burgess Controls

12 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

Explanation of the structure:

Header

1. Template heading

2. Logoontherighthandside(changehasnoeectatpresent)

3. Logoonthelefthandside(changehasnoeectatpresent)

Quick menu

4. Classicationandlinkforthealarmlist

5. Classicationandlinkforthehistory

6. Classicationandlinkforuseradministration

7. Classicationandlinkforthesearchfunction

8. Classicationandlinkfortheinformation

IfyoudonotwanttouseanitemintheQuickmenuorwanttoblankoutanitem,thenenter"null"or

"none"inthe"ord"eldinstead.

Alarm list

Thereareveready-madealarmlists.

Thenameofthelistaswellasthelinkappearintherst,topmostentry.

Ifyoudonotwanttouseanalarmlistorwanttoblankoutalist,thenenter"null"or"none"inthe"ord"

eldinstead.

Additionaloptionscanbedenedinthethreeeldsunderthealarmlist.Thenameisofnorelevance,

justthe"Ord".

Thepathfortheassociatedalarmclassisdenedintherstsubeld.

Inthesecondsubeld,atimecanbesetfortheintervalatwhichthemacroistoashfornewalarms.If

youdonotwantthis,thenenter"null"or"none"inthe"ord"eld.

Saia Burgess Controls

| 13

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

Thethirdeldcanbeusedtodenethecolorofthealarmeldifanalarmispresent.

ThecolorscanbedenedaccordingtotheHTML/CSSstandard.

See:

https://www.w3schools.com/cssref/css_col o rs_legal.asp

https://www.w3schools.com/colo rs/colors_names.asp

This means that the following is possible:

- Hexadecimalcolorspecication

Ahexadecimalcolorisspeciedwith:#RRGGBB,wherethehexadecimalintegersRR(red),

GG (green) and BB (blue) indicate the components of the color. All values must be between

00 and FF.

#0000Red

#0000Green

#0000Blue

- RGB colors

AnRGBcolorvalueisspeciedwithfunctionrgb()whichhasthefollowingsyntax:

rgb (red, green, blue)

Eachparameter(red,greenandblue)denestheintensityofthecolorandcanbeaninteger

between 0 and 255 or a percentage (from 0% to 100%).

For example, the value for rgb (0,0,255) is shown as blue because the parameter blue is set

to the highest value (255) and the others are set to 0.

Thefollowingvaluesalsodenethesamecolor:rgb(0,0,255)andrgb(0%,0%,100%).

- Predenedcolornamesacrossallbrowsers

https://www.w3schools.com/colo rs/colors_names.asp

- etc. See links

Data points

AdatapointfortheoutsidetemperaturecanbeenteredintheOutTemp"Ord."eld.

Ifyoudonotwanttodisplaythis,thenenter"null"or"none"inthe"ord"eld.

Saia Burgess Controls

14 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

6. Translation of the standard texts

The"system"foldercontainsalang.xml lewhereadditionallanguagescanbedenedasnecessary.

Simplycopythetexttaganddenethelanguageunder"lang"anddenethetextintherespectivelan-

guageunder"translation".

See the example in German and English.

Ifalanguageisnotdened,theEnglishoriginalisautomaticallyused.

6.1 Specialmodicationstothemenu.

VariousoptionscanbechangedunderScripts\createMenu.

This is also explained there.

Ifyouwantthemenutobeopenwhenyouopenthepageinthebrowser,youshouldremovethetwo

slashesatthebeginningofthe“//jPM.open(false);”entry.

Saia Burgess Controls

| 15

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

7. Debugging

For example, the console can be used in Chrome for debugging:

Youwillthengetareasonablyclearerrormessageifaproblemisdetected:

Ifnonavlesandnodefaultlesarefound,thenapopupwillappear:

Ifthepathisrenamed,thepathsmustbemodiedinindex.html!

Saia Burgess Controls

Saia-Burgess Controls AG

Bahnhofstrasse 18 | 3280 Murten, Switzerland

T +41 26 580 30 00 | F +41 26 580 34 99

www.saia-pcd.com

[email protected] | www.sbc-support.com

16 |

27-670 – ENG02 – Software Handbook – Saia PCD Supervisor - Device-Template

2020-04-14 | Technical data and information subject to change.

SBC Saia PCD® Supervisor V3.0 - Station Templates Owner's manual

SBC Saia PCD® Supervisor V3.0 - Station Templates Owner's manual

SBC Saia PCD® Supervisor V3.0 - Station Templates Owner's manual

Related papers