Support Guide for viewon 4

Transcription

1 Support Guide for viewon 4 Abstract: Project : Changes and key features of viewon 4 Reference: EQA TPL Revision: 01 Status: PRE-RELEASED Last modification: 09/16/15 Author: Hakan Bilgin ewon sa Proprietary Document User Pursuant to NDA ewon sa Av. Robert Schuman 22 - BE-1400 Nivelles - BELGIUM Tel Fax

2 Table of content 1. Document information Keywords References Glossary and acronyms Glossary Abbreviations and Acronyms Client Side Scripting viewon tags viewon Script sections and Execute viewon Script actions Automated Animations Mobile adaptive view Redirect Actions User Access Rights Other changes and fixes Project Properties Synoptics menu item keyboard accelerators are updated Send measure action New Animation EQA TPL Support Guide for viewon 4 Page 2/12

3 1. Document information File name : Build 181 Modifications History Revision date Modified Sections Modification / Description Author 10/09/ All Document creation Hakan Bilgin 2. Keywords viewon 4 Support Guide 3. References [1] Quality Management Systems - Requirements Ref: ISO9001:2008 [2] Quality Management Systems - Fundamentals and vocabulary Ref: ISO 9000: Glossary and acronyms 4.1 Glossary 4.2 Abbreviations and Acronyms EQA TPL Support Guide for viewon 4 Page 3/12

4 NA (N/A) Non Applicable QA Quality Assurance TBD To Be Defined 5. Client Side Scripting Client side scripting is the new feature which enables users to add their own JS code their view. I will try to explain briefly here this new feature but if you want to have detailed information you may see fred://8db220f9-20db-11dc-af69- bb2459c57c38/browse/id/workspace/spacesstore/8e0a0fdd-4c43-413c-82d1-622fcb17509d document. viewon editor application has been changed in various points for this new feature. 5.1 viewon tags This is a new term which should be explained with importance to the users. ViewON tags means client side tags.if we speak technically they are JavaScript objects. Emphasize that ewon tags and viewon tags ARE NOT SAME. viewon tags are created by the users, ewon tags are imported from ewon. ViewON tags are defined for each view of the project separately. tree. Users may access to viewon tags management by right clicking to their view on the project When users click to viewon tags item they are going to arrive to following screen. EQA TPL Support Guide for viewon 4 Page 4/12

5 This is the list of the viewon tags of the main view. User will add/remove/update their viewon tags of this view via this screen. There are two types of viewon tags; boolean and analog. These viewon tags can be used after in animations/actions and JavaScript sections like ewon tags. Because of that tag selection screen is modified as following; EQA TPL Support Guide for viewon 4 Page 5/12

6 As you can see above tag selection screen which is used in many parts of the application has been changed. So screen shots in our documentation should be updated. An additional viewon tag tab is added and other tabs renamed to be more clearly. And we have a tag description now next to the tag name. 5.2 viewon Script sections and Execute viewon Script actions We saw that we have viewon tags now. But they exist only at the client side and their value is lost every time the page is refreshed. Question comes now: What are these tags for and how to change their value? User can change the value of viewon tags by sendcommand, sendmeasure and sendcommandbyref actions like ewon tags. Users may also change the values of these tags by using the viewon scripts. What is viewon scripts? It is actually JavaScript sections written by the users. We are going to call them as viewon Scripts in order to distinguish from the BASIC Scripting. User may type viewon scripts in two points; 1. Global JavaScript Section: JavaScript code written in this section is directly attached to the view (not to an element) like all other global actions. And this section is executed periodically in the desired interval. EQA TPL Support Guide for viewon 4 Page 6/12

7 NOTE: Minimum limit of execution interval is 100 milliseconds. If user types a value less than 100, section is executed only once. 2. Execute viewon Script Action: This action can be added to buttons and SVG elements. JavaScript code written in this section is executed only when the user triggers the action. NOTE: Now viewon has a special JavaScript code area which highlights and validates the JavaScript syntax. If users type Ctrl + Space this code area will display available functions list. See the screen shot; IMPORTANT: Users need to use some special method calls to read/write ewon/viewon tags. These methods should be documented in detail with their description getewontagval('tagname') getviewontagval('tagname') setewontagval('tagname', value) setviewontagval('tagname', value) reads ewon tag value from the page cache reads viewon tag value writes ewon tag value, send an AJAX call writes viewon tag value You may find more detail about these method in the application. IMPORTANT: These write changes are not directly applied. All change requests are sent to the server (committed) at the end of the script execution. If users want to send these changes directly to the server they should call commitewontagchanges() method after each set tag method calls. But we won't speak about this method a lot. We won't encourage users to use this method. We should provide users to an example code piece to show how to use these methods. NOTE: Users may also access to jquery v2.1.0 and jquery UI v API from this code sections. IMPORTANT: How users may debug their JS code? Users may use the debugging tools of the browsers like Chrome and Firefox to add breakpoints etc.. You should speak about this to the users in the documentation. EQA TPL Support Guide for viewon 4 Page 7/12

8 5.3 Automated Animations Some of the animations can be defined without depending on a tag now. Following two animations have automated (tagless or basic) versions with viewon 4. Translation Basic version of this animation replaces tag/min/max fields with cycle duration and transition fields. Cycle duration time needed to complete the animation from 0% to 100% in seconds Rotation Basic version of this animation replaces tag/min/max fields with cycle duration field. Blink This is a new animation added to viewon. This animations changes the color of an element in a given interval. interval color change interval in milliseconds duty cycle percentage of the duration of the first color first color first of the colors to be displayed second color first of the colors to be displayed 6. Mobile adaptive view Second important improvement in viewon 4 is the new features for mobile devices. If you want detailed information about this development please see; fred://8db220f9-20db-11dc-af69- bb2459c57c38/browse/id/workspace/spacesstore/345bc7be e5f-9c a62f4b33 If I want to explain briefly the major changes first thing to speak about is the creation a,dn modification of the views. We started to provide a list of most used mobile devices/screens to the users. So that users can decide to size of the their views easier than before. IMPORTANT: Fit to screen and keep aspect ratio options are newly added and very important. These option describes the behavior of viewon pages on the browser. Results of these options should be explained to the users with examples. IMPORTANT: View creation and modification screens are modified. They are now done in one step. Related sections of the documentation should be updated with the latest screenshots. EQA TPL Support Guide for viewon 4 Page 8/12

9 Debugger has been updated as well to simulate different screen resolutions and the reaction of the viewon page to these screens. This feature should be explained to the users as well. 6.1 Redirect Actions We saw that we can create different sized views for different screens. Users may want to have a main view and an alternative view to this view for mobile devices. Lets say project has following two views; main main_mobile Users may want to redirect main.shtm to main_mobile.shtm when the main.shtm is displayed with a mobile device. Unfortunately we can't do this redirection on the server side. We can only this on the client side with javascript. Users may add this redirection action to their view from the global actions menu. Alternative Layout is the name of this action. EQA TPL Support Guide for viewon 4 Page 9/12

10 Users select their view will be redirected to which view in which screens. This action should be explained with an example to the users. IMPORTANT: Once you add an alternative layout action to a page, viewon compilation process will create two web pages (I am still using the example above) Pages created; main.shtm main_.shtm This page is an empty page only with the redirect config This page has the real content of the main view. main.shtm redirects the users to main.shtm or main_mobile.shtm regarding to the device screen. 7. User Access Rights This feature is developed by FMT. He can give you the best information. This feature is highly connected to firmware. You may find the detailed information in fred://8db220f9-20db-11dc-af69-bb2459c57c38/browse/id/workspace/spacesstore/1854cc92-6fdd-42d2-8e1d-8c9ab189d343 file. First change about this feature is the Users Right Management screen which allows users to modify existing ewon users access right with an FTP connection. You may access to this screen via Project Users Management item. NOTE: Roles; Viewer, Operator and Admin are the new roles created for the viewon. None of the existing ewon users will have these roles by default. If users want to benefit from this feature they are firstly obliged to configure their users right from this screen. EQA TPL Support Guide for viewon 4 Page 10/12

11 As you can see the screen shot above. Second UI change in the editor is the Access tab under the canvas. Users may decide which user roles can access to the components or to the whole view from this tab. IMPORTANT: Users should enable the User Security option from the project properties to use access filtering. If users disable back the user security option all components and pages will be accessible to every user like before. IMPORTANT: Adm user can't use this feature. If the customer enables the user security on a component. This component can't never be seen by the user Adm. This bug will be fixed in the next firmware release. See FMT for the further explanations. This bug should be explained to users in the documentation. 8. Other changes and fixes All the changes below should be documented with screen shots and examples. 8.1 Project Properties Project properties dialog is accessed from Project menu now. Screen shots should be updated. AJAX refresh timeout value is now configurable from the project properties. 8.2 Synoptics menu item keyboard accelerators are updated They are triggered with Alt key now. 8.3 Send measure action Send measure action dialog now contains a keyboard now. Users without keyboardless devices can use this action now. 8.4 New Animation Text On Interval animation is added. This project changes the text value according to an analog tag value. EQA TPL Support Guide for viewon 4 Page 11/12

12 Configuration IO Server Config IMPORTANT Use this IMPORTANT format to stress important points NOTE Use this box for adding notes inside your documents Configuration IO Server Config EQA TPL Support Guide for viewon 4 Page 12/12