36
Technical Document August 16, 2012 NiagaraAX Mobile Guide

NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

  • Upload
    others

  • View
    12

  • Download
    0

Embed Size (px)

Citation preview

Page 1: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Technical Document

August 16, 2012

NiagaraAX Mobile Guide

Page 2: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

NiagaraAX Mobile Guide

Confidentiality NoticeThe information contained in this document is confidential information of Tridium, Inc., a Delaware corporation ("Tridium"). Such information and the software described herein, is furnished under a license agreement and may be used only in accordance with that agreement.The information contained in this document is provided solely for use by Tridium employees, licensees, and system owners; and, except as permitted under the below copyright notice, is not to be released to, or reproduced for, anyone else.While every effort has been made to assure the accuracy of this document, Tridium is not responsible for damages of any kind, including without limitation consequential damages, arising from the application of the information contained herein. Information and specifications published here are current as of the date of this publication and are subject to change without notice. The latest product specifications can be found by contacting our corporate headquarters, Richmond, Virginia.

Trademark NoticeBACnet and ASHRAE are registered trademarks of American Society of Heating, Refrigerating and Air-Conditioning Engineers. Microsoft and Windows are registered trademarks, and Windows NT, Windows 2000, Windows XP Professional, and Internet Explorer are trademarks of Microsoft Corporation. Java and other Java-based names are trademarks of Sun Microsystems Inc. and refer to Sun's family of Java-branded technologies. Mozilla and Firefox are trademarks of the Mozilla Foundation. Echelon, LON, LonMark, LonTalk, and LonWorks are registered trademarks of Echelon Corporation. Tridium, JACE, Niagara Framework, NiagaraAX Framework, and Sedona Framework are registered trademarks, and Workbench, WorkPlaceAX, and AXSupervisor, are trademarks of Tridium Inc. All other product names and services mentioned in this publication that is known to be trademarks, registered trademarks, or service marks are the property of their respective owners.

Copyright and Patent NoticeThis document may be copied by parties who are authorized to distribute Tridium products in connection with distribution of those products, subject to the contracts that authorize such distribution. It may not otherwise, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form without prior written consent from Tridium, Inc.Copyright © 2012 Tridium, Inc. All rights reserved.The product(s) described herein may be covered by one or more U.S or foreign patents of Tridium.

Page 3: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

CONTENTS

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiDocument Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Getting Started with NiagaraAXMobile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1Licensing mobile apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1

Installing NiagaraAX mobile apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2Install a NiagaraAX mobile app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2Enable or Disable a Mobile App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3

NiagaraAX Mobile Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3About Niagara apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3About Bajascript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3Types of Mobile components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4

About Mobile User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4About Mobile Web Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4About the Mobile Client Environment (mobile) property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5

NiagaraAX Mobile Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1Common Mobile interface controls and indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1

NiagaraAX Mobile Apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1Types of NiagaraAX Mobile Apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1

About the Mobile Property Sheet App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2

About the Mobile Alarm Console App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3

About the Mobile History App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–6

About the Mobile Schedule App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9

Mobile Schedule app Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10

About the Mobile Px App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12

About Mobile Px views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13Viewing Mobile Px files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–13

About Dynamic Mobile Px views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–15

Apps Property Sheet view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–15

About the App Manager view (Workbench) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–16

Plugin Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–1Types of plugin modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–1

Plugins in the app module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–1

NiagaraAX-3.7

NiagaraAX Mobile Guidei

Page 4: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

August 16, 2012

Mobile Component Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–1Types of component modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–1

Components in the app module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–1

Components in the mobile module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–1

NiagaraAX-3.7

NiagaraAX Mobile Guideii

Page 5: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

PREFACE

Preface• Document Change Log• Related documentation

Document Change LogUpdates (changes/additions) to this NiagaraAX Mobile Guide document are listed below.• Initial publication: August 16, 2012

Related documentationThe following documents are related to the content in this document and may provide addition infor-mation on the topics it covers:• NiagaraAX User Guide

NiagaraAX-3.7

NiagaraAX Mobile Guideiii

Page 6: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

August 16, 2012

NiagaraAX-3.7

NiagaraAX Mobile Guideiv

Page 7: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

1CHAPTER

Getting Started with NiagaraAXMobileStarting in NiagaraAX-3.7, mobile applications (apps) are supported and included in the Niagara Framework. These apps and the supporting Niagara environment are designed to work with modern browsers on a personal computer, a mobile phone, or other hand-held devices.

Figure 1-1 NiagaraAX Mobile Web Apps example device browser view

These mobile apps have the potential to run on a variety of platforms, including: iPhone and Android operating systems. Targeted platforms include:• Android default browser

• Android phone 2.3 or later• Processor: 1 gigahertz or greater

• iOS Mobile Safari• iPhone 4 or later• iPad 1 or later

The primary value of mobile web apps is the ability to present users with information in a hand-held browser. However, before the user can view, edit, and navigate between these apps, the apps must be licensed, installed, and configured on a station using NiagaraAX Workbench. The apps that are provided with NiagaraAX-3.7 are easy to install and configure using a simple set of typical NiagaraAX properties.Individually, these apps allow access to a station’s property sheet, alarm console, schedules, histories, and Px pages from appropriate mobile devices. The apps provide many, but not all, of the same field editors that are supplied in the standard NiagaraAX workbench. The NiagaraAX Mobile Apps have an Open API so Niagara developers can create unique field editors in NiagaraAX Workbench and have them appear in the existing apps.

Licensing mobile appsMobile apps are provided as a standard feature with NiagaraAX-3.7, requiring no additional licensing. However, each app is enabled individually, by default, through the license file. Authorized licensing personnel can enable or disable individual apps through licensing. You can verify that apps are licensed by looking at the “mobile” feature line and attribute settings of your license file. An attribute value of “true” indicates that the app is enabled.

NiagaraAX-3.7

NiagaraAX Mobile Guide1–1

Page 8: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Installing NiagaraAX mobile apps Chapter 1 – Getting Started with NiagaraAXMobile

August 16, 2012

Figure 1-2 License file with mobile licensing included

If an app is not enabled (“false”) then it simply does not appear on the associated device.

Installing NiagaraAX mobile appsThe following procedures describe how to install and configure typical mobile apps in a NiagaraAX station.

Install a NiagaraAX mobile appPrerequisites for the following steps include:• NiagaraAX-3.7 workbench or later• Individual apps licensed, as needed

Note: In NiagaraAX-3.7 and later, new stations come with the Apps node already added. There is no need to add a second Apps component if one is already present in the station.

Step 1 From the NiagaraAX workbench, open the mobile palette and drag the Apps component directly onto the Config node in the nav tree.

Figure 1-3 Drag the Apps component onto the Config node in the nav tree

Step 2 Double-click on the Apps node in the nav tree to display the App Manager view in workbench.Step 3 In the App Manager view, click the New button to display the New dialog box.Note: You can add a group of apps if they are contained in an AppFolder (such as the NiagaraAX Mobile folder)

by dragging and dropping the AppFolder onto the Apps node.

Figure 1-4 Adding a mobile app in Workbench using the App Manager

Step 4 In the New dialog box, choose the desired App from the Type to Add option field and click the OK button to display a second New dialog box.

NiagaraAX-3.7

NiagaraAX Mobile Guide1–2

Page 9: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile ConceptsAugust 16, 2012 About Niagara apps

Figure 1-5 Choose an App from the New dialog box

Step 5 In the New dialog box, edit the name and enable the app, as desired, and click the OK button to complete the installation.All installed apps display in the App Manager view with information identifying the app and its status.

Figure 1-6 App Manager view with two apps installed

Enable or Disable a Mobile AppTo change the Enabled status of an app, do the following:

Step 1 In NiagaraAX workbench, double-click on the desired app in the nav tree to display the app property sheet view.

Step 2 In the property sheet view, set the Enabled status to the desired state: true (Enabled) or false (Disabled) and click the Save button.When an app Enabled property value is set to false, the app does not appear in a device browser.

NiagaraAX Mobile ConceptsThe following sections describe some of the major Niagara Mobile app concepts:• About Niagara apps• About Bajascript• About Mobile User Access• Types of Mobile components

About Niagara appsIn some ways, the “app” concept is similar to the existing NiagaraAX “service” concept. However, the app brings much more to the Framework than a service. With the popularity of apps and handheld devices, most users understand the app concept and are comfortable with using apps. In NiagaraAX, the app simply provides a focus or center point for a specific set of tasks and functions that are grouped together to address a single objective. The app may use other services and drivers, but the app itself is clearly identified by the common set of functions that it performs or views that it provides for doing a particular job.Mobile Niagara apps are Open Web apps that are configured right in your NiagaraAX station. Once you set them up in your station they are available to serve views and data to both mobile browsers and desktop browsers.

About BajascriptBajascript is a data API for accessing (and manipulating) Niagara data. This API enables access to Niagara data, so that you can build Web Apps around it. The browser already defines the whole UI piece so that Bajascript simply adds the Niagara data part. Bajascript works with the BOX service, which is added to your station automatically when you install one or more apps. See www.bajascript.com for more details.

NiagaraAX-3.7

NiagaraAX Mobile Guide1–3

Page 10: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About Mobile User Access Chapter 1 – Getting Started with NiagaraAXMobileTypes of Mobile components August 16, 2012

Types of Mobile componentsWith Mobile apps installed, the following new components are added to a station:

Figure 1-7 Mobile components in a station nav tree

• Apps ContainerThe Apps container is provided by default in a new AX-3.7 or later station. It is required for using mobile apps. The Apps container provides a central location for all designated mobile apps including the provided NiagaraMobileApps. In NiagaraAX-3.7, new stations come with this Apps node al-ready installed in a station, directly under the Config node.

• Box ServiceBox is the protocol that Bajascript uses. This service is automatically added when you add one or more Mobile apps to the Apps folder.

• Mobile App setThis is the default set of Mobile apps provided in NiagaraAX-3.7.See “NiagaraAX Mobile Apps” on page 3-1 for details:• Mobile Property Sheet• Mobile Alarm Console• Mobile History• Mobile Schedule• Mobile Px

About Mobile User AccessMobile apps can take advantage of standard NiagaraAX features, such as Profiles, Nav Files, Px views, and Niagara security to control a user’s navigation and access to individual views and components. However, if a station is licensed to use NiagaraAX Mobile, then the following additional properties are available:• Mobile Web Profile property

This property allows you to specify a unique and appropriate mobile-friendly interface for users that login from a mobile device. Refer to “About Mobile Web Profile” on page 1-4 for more details.

• Mobile Client Environment propertyThis property is used to detect the client environment based on the client browser’s “user-agent” string. Refer to About the Mobile Client Environment (mobile) property for more details.

About Mobile Web ProfileThe Mobile Web Profile is an additional profile property that is added to every user in a Mobile-licensed station. This additional profile category lets you assign a specific profile for the user that logs into a station from a mobile device. For example, when a user logs into a station from a mobile platform (cell phone, tablet, or similar) the WebService Component (see About the Mobile Client Environment (mobile) property) can detect that the login is from a mobile platform and use the Mobile Web Profile that is specified for the user. If the same user logs in from a PC based browser, the Default Web Profile value is used instead.

NiagaraAX-3.7

NiagaraAX Mobile Guide1–4

Page 11: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 1 – Getting Started with NiagaraAXMobile About Mobile User AccessAugust 16, 2012 About the Mobile Client Environment (mobile) property

Figure 1-8 Mobile Web Profile in the Edit User dialog box

Mobile Web Profile properties include the following:• Mobile Nav File

The mobile nav file works with the Mobile Web Profile independently from the Default Web Profile, although you could use the same nav file for both profiles. Unlike the nav file in the Default Web Pro-file, the mobile nav file only uses the root node of the nav file. Therefore, the mobile nav file simply determines your initial landing page on login, which is also your “home” page. Typically, you create the nav file and then assign the nav file to a user. A user’s nav file determines the initial targeted com-ponent for that user. The actual view may depend on user permissions and category settings for views assigned to that component.

• TypeThis is where you choose the profile that you want to use for mobile client devices when the Mobile Client Environment property is enabled. The default setting for this field is the Default Hx Pro-file option. In addition to this Hx profile, you can choose from any of the other standard Hx pro-files and typically you would choose the Default Mobile Web Profile.Note: The mobile.jar file is an optional module in a NiagaraAX station. Therefore, it is possible for a station to be licensed for mobile and not support mobile (if the module is not present). To prevent possible initial login failure for mobile devices, the Default Mobile Web Profile is specified as the Default Hx Profile. This applies to new stations in NiagaraAX-3.7 or stations that are upgraded to NiagaraAX-3.7 from earlier versions. The Default Hx Profile allows login from mobile devices and may even be preferred for mobile, in some cases. Choose the desired Mobile Web Profile for each user.

• Default Mobile Web Profile propertiesIf you choose the Default Mobile Web Profile the following additional properties appear to provide options for configuring the profile:• Theme (choice of 3 themes)• Show Header• Show Footer• Show Header Back Button• Show Select Views• Show HomeThese properties are described in more detail in “Common Mobile interface controls and indicators” on page 2-1.

Note: The Default Mobile Web Profile is also available from the Default Web Profile property options as a convenience for working with mobile views on your PC browser.

About the Mobile Client Environment (mobile) propertyThe Mobile Client Environment (mobile) property is located under Client Environments in the WebService component of a station. The purpose of the Mobile Client Environment property is to determine if a user’s browser is running on a mobile or desktop platform. This information allows a single credential set (user name and password) to support multiple client environments.

Figure 1-9 Mobile Client Environment under WebService, Client Environments property

NiagaraAX-3.7

NiagaraAX Mobile Guide1–5

Page 12: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About Mobile User Access Chapter 1 – Getting Started with NiagaraAXMobileAbout the Mobile Client Environment (mobile) property August 16, 2012

When enabled, the Mobile Client Environment property, uses the settings in the User Agent Pattern property, to determine the type of client device that is connecting. Based on this determination, the station uses the appropriate profile, as assigned to the User Name for Mobile Web Profile or Default Web Profile. For example, if you are connecting from a browser running on your laptop PC, the Mobile Client Environment property settings should determine that you are using a non-mobile device. Your Default Web Profile and associated Nav File are then used and affect your: initial page display, navigation and display options. If you login from your mobile phone or tablet, the Mobile Client Environment property settings should determine that you are using a mobile device. Your Default Mobile Web Profile and associated Nav File are then used and affect your: initial page display, navigation and display options.The Mobile Client Environment properties include the following:• Enabled

True and false options are available to enable or disable the property, respectively. When the En-abled property is set to false, the Mobile Client Environment is not checking for a client platform. In this case, the user’s Default Web Profile is used on login from a browser.

• StatusThis is the standard status field that normally should read [ok] when the property is enabled.

• Fault CauseThis is the standard Fault field that indicates a reason for a fault.

• User Agent PatternThis property has an editable field that contains a “regular expression” that is used to determine if a client browser is from a Mobile or Desktop platform. The regular expression is tested against the in-formation in the User-Agent string that the client device sends to the station. If the platform is found to be a Mobile device, a user's Mobile Web Profile is used. If not, then the standard Default Web Pro-file is used instead.Although this regular expression can be changed, for most situations, it is best to leave it at the de-fault settings.

Note: It is possible for a user to force a particular client environment through a URL in the browser. To force a desktop client environment, use the following URL in your client browser:http://localhost/webenv/desktop orhttp://localhost/webenv/default

To force a mobile client environment use the following URL in your browser:http://localhost/webenv/mobile

NiagaraAX-3.7

NiagaraAX Mobile Guide1–6

Page 13: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

2CHAPTER

NiagaraAX Mobile InterfaceThe Default Mobile Web profile type includes properties that let you choose various “Themes” as well as choose to display or hide certain elements of the profile. Themes affect the colors and graphic shapes but do not change the functionality of the apps themselves. The default elements of the interface are included in all theme types. Developers can modify themes or create new themes using the jQuery mobile framework (http://jquerymobile.com) website.The following sections describe the major common mobile interface features:

Common Mobile interface controls and indicatorsThe NiagaraAX Mobile interface is comprised of mobile-friendly views that use some common controls and indicators to make the Niagara station features and assets available from mobile devices.

Figure 2-1 App Desktop view - common controls and indicators

• HeaderThis indicator contains the name, or display name, of the app as well as the Back button and the Commands button. You can hide or show the header by using the Show Header property in the user profile settings. Hiding the header removes the Back and Commands buttons.

• Back buttonThis button is located on the left side of the header. When you click it, it displays the previous view. If you choose to hide the header, then this button does not display.

• Commands buttonWhen clicked, this control opens the Commands menu. If you choose to hide the header, then this button does not display.

• Navigation BarThis set of tabs displays below the Header on property sheet views to allow you to navigate through accessible areas of the station. The left to right arrangement reflects the top to bottom hierarchy of the station nav tree.

NiagaraAX-3.7

NiagaraAX Mobile Guide2–1

Page 14: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Common Mobile interface controls and indicators Chapter 2 – NiagaraAX Mobile Interface

August 16, 2012

Figure 2-2 Mobile nav bar and control buttons

• Control ButtonsThese buttons display horizontally across the bottom of the view. The buttons are available, as ap-propriate, for saving changes, refreshing the view or initiating actions in the view. In history table views Next (>) and Previous (<) buttons let you show the next or previous set of records.

• Color IndicatorsFor any control, the following colors indicate:• Green

Green text indicates an editable field.• Red

Red text and red graphics indicate an unsaved change has been made.• Mobile Desktop view (App Desktop view)

This is the default view for the AppContainer and any AppFolder that is viewed from a mobile de-vice. The desktop area shows an icon for each app or folder that it contains.

Figure 2-3 App Desktop in Workbench and in the browser

• NiagaraAX Mobile Web Apps FolderThis folder is available from the mobile palette. By default, it contains all of the Niagara Mobile apps. You can add more folders or more apps to this view as they are available.

Figure 2-4 Niagara Mobile Web Apps Desktop

NiagaraAX-3.7

NiagaraAX Mobile Guide2–2

Page 15: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 2 – NiagaraAX Mobile Interface Common Mobile interface controls and indicatorsAugust 16, 2012

• Apps Folder This optional component is available from the App palette. It is simply a container for apps that you can use to help organize apps in the station. You can add more folders or more apps to this view as they are available. The default view for this component is the Apps Desktop view in a browser or the App Manager view in Workbench.

NiagaraAX-3.7

NiagaraAX Mobile Guide2–3

Page 16: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Common Mobile interface controls and indicators Chapter 2 – NiagaraAX Mobile Interface

August 16, 2012

NiagaraAX-3.7

NiagaraAX Mobile Guide2–4

Page 17: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

3CHAPTER

NiagaraAX Mobile AppsNiagaraAX-3.7 includes a group of mobile apps that provide access to the standard NiagaraAX station functions of alarming, scheduling, histories and other areas. These apps are designed to work with mobile devices and provide a common user experience that is familiar to NiagaraAX users. The following sections describe the individual apps that are included in the mobile module as well as the Workbench views common to Apps.• Types of NiagaraAX Mobile Apps• Apps Property Sheet view• About the App Manager view (Workbench)

Types of NiagaraAX Mobile Apps

The following apps are included in the NiagaraAX-3.7 mobile module and are available from the mobile palette:

Figure 3-1 NiagaraAX Mobile apps

• Mobile Property SheetThis app provides a mobile interface for Niagara station property sheet views. Refer to “About the Mobile Property Sheet App” on page 3-2 for more details about the Property Sheet app.

• Mobile Alarm ConsoleThis app provides a mobile interface for the Niagara Alarm Console. Refer to “About the Mobile Alarm Console App” on page 3-3 for more details about the Alarm Console app.

• Mobile HistoryThis app provides a mobile interface for Niagara History displays. Refer to “About the Mobile His-tory App” on page 3-6 for more details about the Mobile History app.

• Mobile ScheduleThis app provides a mobile interface for Niagara Scheduling displays. Refer to “Mobile Schedule app Interface” on page 3-10 for more details about the Mobile Schedule app.

• Mobile PXThis app provides an interface that allows System Integrators to build their own Mobile Px views. Refer to “About the Mobile Px App” on page 3-12 for more details about the Mobile PX app.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–1

Page 18: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About the Mobile Property Sheet App Chapter 3 – NiagaraAX Mobile Apps

August 16, 2012

About the Mobile Property Sheet AppThe Mobile Property Sheet app allows you to navigate through the entire component hierarchy of your NiagaraAX station. You can use this app to view and edit points as well as initiate actions, as needed.

Figure 3-2 Mobile Property Sheet app in Workbench and Mobile Desktop view

Note: Not all field editors are supported in the NiagaraAX-3.7 release of Niagara Mobile, but the primary ones are, such as fields for points, and point extensions. Niagara Mobile uses a public API that is available so that developers can add field editors in the supplied apps. Future releases will also provide more field editors for the mobile app. • Mobile Property Sheet App prerequisites:

Following are the requirements for using the Mobile Property Sheet app. If any of these prerequisites is not fulfilled, instead of displaying in a “disabled” mode, the app simply does not appear:• Apps container installed

The Apps container is located in the mobile module. If your station does not have one, install the Apps container by dragging it onto the Config node in the nav tree.

• App installed This app is located in the mobile module, under the NiagaraMobileWebApps folder. Install

the app by dragging it onto the Apps container in the nav tree.• Licensed

This app is provided as already licensed by default. You can check that the propsheet=”true” attribute is in the mobile feature line of your license. See “Licensing mobile apps” on page 1-1 for details.

• Status OKIn NiagaraAX Workbench, check that the app Property Sheet view (or the App Manager view) shows the app Status as {ok}.

• SecurityThe User (as edited in the User Service, Permissions) must have at least a “read” level access for the app or the app does not appear in the browser when the user logs in.

• Mobile Property Sheet app interfaceNote: Changes to the Workbench property sheet update almost immediately to the mobile view. If you delete an element in your station from Workbench, the mobile view may display it with a “removed” annotation until the next view refresh.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–2

Page 19: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps About the Mobile Alarm Console AppAugust 16, 2012

Figure 3-3 Example Mobile Property Sheet view

The app default (Property Sheet) view appears when you select the Mobile Property Sheet icon from the Mobile Desktop view. Note: If you disable your Property Sheet app from this view and navigate away from it in your mobile device, you may not be able to get back to it without using a Workbench connection to enable it.In addition to the standard Niagara Mobile controls and indicators (see “Common Mobile interface controls and indicators” on page 2-1), the Mobile Property Sheet app uses the following:• Save

The Save button is available whenever a value is changed. Changed values that are not saved are displayed in Red.

• RefreshThe Refresh button is typically displayed for all pages. When you select Refresh, you are alerted if you have any unsaved changes on the page.

• ActionsThe Actions button is displayed on views that have actions available.

About the Mobile Alarm Console AppThe Mobile Alarm Console app provides a mobile view of a standard NiagaraAX station Alarm Console Recipient. The app allows to you view the alarms for each of your alarm recipients with all detail fields of individual alarms. In addition, you can acknowledge alarms and add notes, as with the standard NiagaraAX alarm console.

Figure 3-4 Alarm Console app in Workbench and Mobile Desktop view

• Mobile Alarm Console App prerequisites:Following, are the requirements for using the Mobile Alarm Console app. If any of these prerequi-sites is not fulfilled, instead of displaying in a “disabled” mode, the app simply does not appear:• Apps container installed

The Apps container is located in the mobile module. If your station does not have one, install the Apps container by dragging it onto the Config node in the nav tree.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–3

Page 20: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About the Mobile Alarm Console App Chapter 3 – NiagaraAX Mobile Apps

August 16, 2012

• Alarm Console App installed This app is located in the mobile module, under the NiagaraMobileWebApps folder. Install

the app by dragging it onto the Apps container in the nav tree.• Licensed

This app is provided as already licensed by default. You can check that the alarm=”true” at-tribute is in the mobile feature line of your license. See “Licensing mobile apps” on page 1-1 for details.

• Status OKIn NiagaraAX Workbench, check that the app Property Sheet view (or the App Manager view) shows the app Status as {ok}.

• SecurityThe User (as edited in the User Service, Permissions) must have at least a “read” level access for the app or the app does not appear in the browser when the user logs in.

• Mobile Alarm Console app interfaceThe Mobile Alarm Console view appears when you select the Mobile Alarm Console icon from the Mobile Desktop view or when you select if from a Mobile Property Sheet view (using the Mobile Property Sheet app).

Figure 3-5 Example Alarm Console view

Like the standard NiagaraAX alarm console, the Mobile Alarm Console app manages alarms on a per-point basis. Each row in the alarm console is the most recent alarm from a point. To view all the current alarms or to get more details about a particular alarm from that point, tap the Details but-ton at the right side of the alarm row.In addition to the standard Niagara Mobile controls and indicators (see “Common Mobile interface controls and indicators” on page 2-1), the Mobile Alarm Console app uses the following:

NiagaraAX-3.7

NiagaraAX Mobile Guide3–4

Page 21: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps About the Mobile Alarm Console AppAugust 16, 2012

Figure 3-6 Example Open Alarm Sources view

• Select AllClick this check box to select all alarms that are currently loaded on the page. Note: “Select All” selects any alarms that are not visible but loaded on the page (for example, alarms 21 - 30 in the image above; you can scroll down to see them). Alarms that are on Previous or Next pages are not selected. Use the command buttons, at the bottom of the view, to perform actions (Acknowledge, add Notes, Clear, or see Fields) for any selected alarms.

• SelectClick this check box to select associated alarm.

• DetailsThis button displays either the Alarm Details view or, if you are looking at the most recent of multiple alarms, it displays a listing of all the alarms from that point. If you have multiple pages of alarms listed, use the Page Nav buttons (Previous and Next) to move between the pages.

• Page NavThe Page Nav buttons are active as needed, to display consecutive alarm records or alarm da-ta. Use the Previous or Next buttons to navigate through consecutive pages or records.

• CommandsThese buttons display on views that have actions available. The buttons are available when you have one or more alarm Select boxes checked. – Acknowledge

Click this button to Acknowledge all selected alarms.– Notes

Click this button to open the Notes dialog box and add notes to the selected alarms.– Clear

Click this button to Clear the selected alarms.– Fields

Click this button to open the Choose Fields dialog box. Use this dialog box to add or hide alarm data in alarm rows using the alarm data facets, in the same way that you do in the standard NiagaraAX alarm console.

Note: The NiagaraAX-3.7 version of the Mobile Alarm Console does not play sounds.• Alarm source data is translated for mobile presentation:

• BFormat text is translated from the alarm source.• Custom hyperlinks• Custom icons

• Local storageThis is an HTML 5 feature that provides local device storage for user-designated preferences. For example, you can configure your alarm console columns to display only the data you want and those options are cached on the device for use the next time you login on that device.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–5

Page 22: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About the Mobile History App Chapter 3 – NiagaraAX Mobile Apps

August 16, 2012

About the Mobile History AppThe Mobile History app provides mobile views of history data in both chart and table displays. You can navigate to the Mobile History app through the desktop view or via Px page links. This app supports the following standard NiagaraAX history features:• Delta mode reporting for charts and table views• Relative and specific time ranges • Zooming (for charts)• Column selection (for tables)

Figure 3-7 Mobile History app in Workbench and Mobile Desktop view

• Mobile History App prerequisites:Following, are the requirements for using the Mobile History app. If any of these prerequisites is not fulfilled, instead of displaying in a “disabled” mode, the app simply does not appear:• Apps container installed

The Apps container is located in the mobile module. If your station does not have one, install the Apps container by dragging it onto the Config node in the nav tree.

• History App installed This app is located in the mobile module, under the NiagaraMobileWebApps folder. Install

the app by dragging it onto the Apps container in the nav tree.• Licensed

This app is provided as already licensed by default. You can check that the history=”true” attribute is in the mobile feature line of your license. See “Licensing mobile apps” on page 1-1 for details.

• Status OKIn NiagaraAX Workbench, check that the app Property Sheet view (or the App Manager view) shows the app Status as {ok}.

• SecurityThe User (as edited in the User Service, Permissions) must have at least a “read” level access for the app or the app does not appear in the browser when the user logs in.

• Mobile History app interfaceThe Mobile History listings view appears when you select the Mobile History Console icon from the Mobile Desktop view or from a hyperlink in Mobile Px. The first view is a listing of histories directly under the station, with the station name in the header area.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–6

Page 23: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps About the Mobile History AppAugust 16, 2012

Figure 3-8 Example Mobile History views with no Grouping

If you are using the History Grouping folder (under the History Services node), then the histories are grouped according to the organization of your history grouping folders.

Figure 3-9 Example comparing grouped history views in Workbench nav tree and Mobile app view

In addition to the standard Niagara Mobile controls and indicators (see “Common Mobile interface controls and indicators” on page 2-1), the Mobile History Console app uses the following:

Figure 3-10 Mobile History Controls display a Chart, Table, or Time Range dialog box

• Chart Click this control to create a chart of the active history record. In addition to the standard mobile controls (see “Common Mobile interface controls and indi-cators” on page 2-1), chart controls include the following:– Highlight

Use this control to toggle between Highlight enabled ( )and Highlight disabled ( ). When Highlight is enabled, you can touch and drag a defining area of the chart to enlarge (or “zoom-in”) on it. When the control is toggled to the disabled setting, zoom-highlight-ing is disabled. It might be useful to disable highlighting when you want to touch the screen without zooming in.

– Reset Zoom

NiagaraAX-3.7

NiagaraAX Mobile Guide3–7

Page 24: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About the Mobile History App Chapter 3 – NiagaraAX Mobile Apps

August 16, 2012

Click the Reset Zoom control ( ) to return a zoomed-in display to normal size (no zoom).

– Delta Click the delta control ( ) to create charts with delta reporting. This option is useful when you want to display value changes (delta) in your report. This control is located in the Time Range dialog box.

– Hover TextYou can display X and Y axis data from a point on the chart display by touching the point. The point data displays, as shown in the following illustration.

Figure 3-11 Mobile History Chart Zoom and Hover Text feature

• Table Click this control to display a table of the data for the selected history. In addition to the stan-dard table controls (see “Common Mobile interface controls and indicators” on page 2-1) you can use the Time Range dialog box to select a unique range or a preset range of data. Addi-tional table controls include the following:– Column sorting

Sort your table by columns by clicking on the heading of the column you want to sort by.– Column selection

Show or hide table columns using the columns chooser. Click the button to show the column chooser.

– Next > Prev < buttons These buttons appear in the control bar when there are more records in the table than dis-played on one view. Use the buttons to advance to the next or previous set of records.

• Time Range dialog box This dialog box is used for setting a time range of records to display in your table or chart. You can type directly in the date and time fields or use the date and time chooser tool by clicking the Time Picker button.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–8

Page 25: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps About the Mobile Schedule AppAugust 16, 2012

Figure 3-12 Time Range dialog box

– Time RangeUse this button to choose from a list of relative time range options.

– DeltaUse this control ( ) to create charts with delta reporting. This option is useful when you want to display value changes (delta) in your report.

– Date/Time FieldsType directly in these fields to designate a custom time range.

– Time PickerChoose this button to open the Time Picker tool. the Time Picker tool is simply a convenience tool for entering time data.

About the Mobile Schedule AppThe Mobile Schedule app supports mobile viewing and touch-based editing of standard NiagaraAX schedule components and views. On a mobile touchscreen, tap the Mobile Schedule icon on the Mobile Desktop to open the Mobile Schedule app.

Figure 3-13 Mobile Schedule app in Workbench and Mobile Desktop view

Note: With the Mobile Schedule app enabled, you can also use a Mobile Property Sheet view or a link from a Mobile Px page view to navigate to individual schedules in your station from a mobile device. All the standard NiagaraAX schedule views are available using the Mobile Schedule app, including: • Boolean Schedule• Calendar Schedule• Enum Schedule• Numeric Schedule

NiagaraAX-3.7

NiagaraAX Mobile Guide3–9

Page 26: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Mobile Schedule app Interface Chapter 3 – NiagaraAX Mobile Apps

August 16, 2012

• String Schedule• Trigger Schedule• Mobile Schedule App prerequisites:

Following, are the requirements for using the Mobile Schedule app. If any of these prerequisites is not fulfilled, instead of displaying in a “disabled” mode, the app simply does not appear:• Apps container installed

The Apps container is located in the mobile module. If your station does not have one, install the Apps container by dragging it onto the Config node in the nav tree.

• Schedule App installed This app is located in the mobile module, under the NiagaraMobileWebApps folder. Install

the app by dragging it onto the Apps container in the nav tree.• Licensed

This app is provided as already licensed by default. You can check that the schedule=”true” attribute is in the mobile feature line of your license. See “Licensing mobile apps” on page 1-1 for details.

• Status OKIn NiagaraAX Workbench, check that the app Property Sheet view (or the App Manager view) shows the app Status as {ok}.

• SecurityThe User (as edited in the User Service, Permissions) must have at least a “read” level access for the app or the app does not appear in the browser when the user logs in.

Mobile Schedule app InterfaceThe Mobile Select Schedule view appears when you select the Mobile Schedule Console icon from the Mobile Desktop view or from a hyperlink in Mobile Px. The default view is a listing of all the station schedules, with the station name in the header area. In this view, a separate link is displayed for each schedule in the station.

Note: The Mobile Schedule app shows schedules from all locations in the station. Schedules do not have to be located in the same directory.

Figure 3-14 Schedule Selector view from the Mobile Schedule app

Within each type of schedule, the standard Niagara schedule view types are available. Within these views, the Mobile Schedule app has some unique controls for each of the views, as necessary:• Weekly Schedule tab

In addition to the mobile versions of all the standard Niagara Schedule controls, this view provides color display for boolean schedules, as shown below.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–10

Page 27: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps Mobile Schedule app InterfaceAugust 16, 2012

Figure 3-15 Mobile Schedule app Weekly Schedule tab

Touch the calendar in this view to open the Edit Day view where you can Create, Edit, Delete, and assign Options to the calendar using appropriate touch controls.

• Special Events tab

Figure 3-16 Mobile Schedule app Special Events tab

This view allows you to use touch controls to add Special Events (such as holidays) to your schedule. Use the controls at the bottom of the view to Add, Edit, Rename, Delete and manage priority of the calendar’s Special Events.

• Properties view

Figure 3-17 Mobile Schedule app Properties tab

This view displays all the standard properties of the selected schedule. You can use the touch con-trols to change the date, Default Output, Facets, and other options, as appropriate.

• Summary viewThis view displays a single-month, touch-sensitive calendar that is color-coded to indicate days that have scheduled events. Events for the selected (single) day display in a list below the calendar. You can change the active day display by touching the desired day on the calendar.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–11

Page 28: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About the Mobile Px App Chapter 3 – NiagaraAX Mobile Apps

August 16, 2012

Figure 3-18 Example Mobile Schedule app Summary tab

The calendar has the following touch controls:• Event day

Touch a Day icon to display events for that dayIn the example figure below (using the active Mobile theme), – Yellow colored days have an event scheduled.

– Blue colored days do not have an event scheduled.

• Month controlsYou can change months using the Plus and buttons in the top corners of the active cal-endar.

Note: Display controls appear differently, depending on the mobile theme that is active for the user.

About the Mobile Px AppThe Mobile Px app allows you to create your own app views in the Px Editor, without having to use any software programming language. This includes the ability to use the standard Niagara Px Editor to design views with navigation and custom controls that display and work well in a hand held device. You can think of the Mobile Px app as an “app builder” itself.

Figure 3-19 Mobile Px app in Workbench and Mobile Desktop view

Mobile Px provides a way for you to present live data and field editors in expandable lists that are designed to work well with mobile devices. It is not for absolutely positioning graphics or other media on the page, such as you would for designing a visual layout of a controls system. When you create views with Mobile Px, the display is not an exact representation of what you have in the Px Editor or what you would expect to see when you are displaying views created using Hx. Instead, for Mobile Px views, the Px Editor works as a tool to create views that the Mobile Px app interprets and presents using such “mobile-friendly” features as: rounded buttons, “liquid” layout, dynamic views, and others.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–12

Page 29: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps About Mobile Px viewsAugust 16, 2012 Viewing Mobile Px files

Many of the standard Px graphic widget and property options are still available for configuring your Px page, including:• Buttons

Add standard buttons (Action Button, Hyperlink Button, Save Button) from the kitPx palette. These buttons work the same but appear rounded in mobile views.

• Labels and bound labelsAdd standard labels from the kitPx palette.

• Field editors• Graphic alignment• Font family• Font size and style

About Mobile Px viewsMobile Px views are different from standard Px views. In order to create a Mobile Px view, you must select the Mobile Px View option from the option list in the New Px View dialog box.

Note: If you do not assign Mobile PxMedia to your view, the view does not display or displays an error when opened from a mobile device.

Figure 3-20 Creating a Mobile Px view

Mobile Px view files have the media attribute set to “mobile:MobilePxMedia” as opposed to other media types, such as “workbench:WbPxMedia”, as shown in the following figure.

Figure 3-21 MobilePx files use different media value

It is also important to note that the base element in the Px Editor Widget Tree must be a BasicMob-ilePane, as shown in the following figure.

Figure 3-22 BasicMobilePane root element required in Widget Tree

Note: You can animate any widget property. This is different from Hx because Mobile Px uses Bajascript and a completely new Px engine. In Hx, you have a virtual Hx page in the “Station” and a copy of that is rendered in the client (browser). In Mobile Px everything is running in the browser, which uses Bajascript to run things and to take advantage of the processing power of the mobile device and its browser.

Viewing Mobile Px filesStations with the Mobile Px app enabled can display Mobile Px views under the following conditions:• View created on a component

Px files do not display unless they are assigned to a view on a component. Mobile-enabled Px files that are assigned to views are displayed under the Mobile Px app in a single vertical listing, no matter how they are organized or nested in the station.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–13

Page 30: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About Mobile Px views Chapter 3 – NiagaraAX Mobile AppsViewing Mobile Px files August 16, 2012

Note: Common practice is to relativize a Px view so you can use it on many components. For Mobile Px, you need to assign a unique PxView display name to each component in order to distinguish the initial component Px view listings. The following figure illustrates this.

Figure 3-23 Using unique display names on 2 of 4 folders using the Meters.px file

Notice in this example that all of the buttons (BoundLabels) show a name. The name is derived from the folder component’s PxView “Display Name”. For the first and second buttons (from the top), the component’s PxView Display Name is edited to “North Meters” and “South Meters”, respectively. In the next two buttons the PxView display name is not changed yet and displays the default “Meters” text that was there when the view was initially duplicated.

• Component View settingTargetMedia property set to Mobile PxMedia. This setting is on the component view and can be reset or changed from the component’s property sheet.

Figure 3-24 Target Media set to Mobile PxMedia

• Px file Root elementThe Px file must have a BasicMobilePane as its root element

Figure 3-25 BasicMobilePane required in the root of Px file

• Supported mobile widgetsYou must use mobile-supported widgets in the mobile Px file.

Figure 3-26 Unsupported widgets display error message in Mobile browser

NiagaraAX-3.7

NiagaraAX Mobile Guide3–14

Page 31: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Chapter 3 – NiagaraAX Mobile Apps About Dynamic Mobile Px viewsAugust 16, 2012 Viewing Mobile Px files

About Dynamic Mobile Px viewsDynamic Mobile Px views provide a way to quickly convert an existing Workbench Px view to a Mobile Px view. If you already have a Px view, you can create a dynamic Mobile Px view by selecting Dynamic View from the New Px View dialog box and choosing the mobile:PxToMobile option.

Figure 3-27 Creating a Dynamic Mobile Px view

When you select OK, the conversion process creates an additional Mobile Px view that aligns and adjusts all supported Px elements into a more mobile - ready layout on a new page. The original page is not changed and a new Px page is created.

Note: Not all Px components support dynamic view conversion. Only supported components are represented on the new Dynamic Px page.

Apps Property Sheet viewIn Workbench, the property sheet view is the default view of any app. Different mobile apps share many of the same properties. The default set of mobile apps have the following properties, as seen from their Property Sheet view:

Figure 3-28 NiagaraAX Mobile Apps properties

• StatusStandard Niagara status indicator. This read-only field indicates the status of the associated app: {ok}, {down}, {disabled}, or other.

• Fault CauseStandard Niagara fault display. This read-only field indicates a possible fault cause, if appropriate.

• EnabledStandard Niagara Enabled property. This field allows you choose an option to Enable (true) or Dis-able (false) the app.

• VersionThis read-only field displays the app version.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–15

Page 32: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

About the App Manager view (Workbench) Chapter 3 – NiagaraAX Mobile AppsViewing Mobile Px files August 16, 2012

About the App Manager view (Workbench)In Workbench, the App Manager view is the default view of the Apps container and any App folder.

Figure 3-29 Apps container with default (App Manager view)

This view is helpful for organizing apps by folders. The following buttons provide controls for adding, editing and viewing apps:• New Folder

Click to name and add a new App Folder.• All Descendants

Click to display or hide the apps that are nested in folders.• New

Click to add a new Apps Folder.• Edit

Click to rename, enable, or disable a selected app.Note: You can install individual apps from the Apps container default view, the App Manager view, using the

Install button OR, you can drag the “NiagaraMobileApps” container directly onto the Apps folder, from the mobile palette.

NiagaraAX-3.7

NiagaraAX Mobile Guide3–16

Page 33: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

4CHAPTER

Plugin GuidesPlugins provide views of components and can be accessed many ways. For example, double-click a component in the nav tree for its default view. In addition, you can right-click a component, and select from its Views menu. For summary documentation on any view, select Help > On View (F1) from the Workbench menu, or press F1 while the view is open.

Types of plugin modulesFollowing, is a list of the plugin-related modules:• Plugins in the app module

Plugins in the app module• AppManager

app-AppManager The App Manager is the default view of the Apps component (App Container) as well as any

AppFolders. You can use this view to show a tabular listing of all apps in your station. The table of apps contains columns that indicate: app Name, Type, Version, Status, Enabled state and Fault Cause (if any). You can add new apps, add new AppFolders, or edit existing apps from this view. See “About the App Manager view (Workbench)” on page 3-16 or more details about the App Manager view.

NiagaraAX-3.7

NiagaraAX Mobile Guide4–1

Page 34: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Plugins in the app module Chapter 4 – Plugin Guides

August 16, 2012

NiagaraAX-3.7

NiagaraAX Mobile Guide4–2

Page 35: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

5CHAPTER

Mobile Component GuidesThese component guides provide summary help on NiagaraAX Mobile components.:

Types of component modulesFollowing, is a list of the mobile component modules:• AppModule• Mobile Module

Components in the app module• App Container• App Folder

app-AppContainer Starting in NiagaraAX-3.7, new stations come with an App Container, already installed as a node directly under the station’s Config node in the Workbench nav tree. This component is also available from the app or mobile palettes. Any mobile apps that you want to add to your station must be placed directly under this container or in an App Folder that is in the Apps container. See “Types of Mobile components” on page 1-4 for more details about the App Container component.

app-AppFolderThe AppFolder component is a container for apps and is available in the app module. You can use these folders to organize apps and nest them under the AppContainer (Apps) component. Only the Apps component and other AppFolder components are legitimate locations for placing these folders. See “Types of Mobile components” on page 1-4 for more details about using these folders.

Components in the mobile module• Niagara Mobile Web Apps• Mobile Property Sheet App• Mobile Alarm Console App• Mobile History App• Mobile Schedule App• Mobile Px App• Basic Mobile Pane• Mobile Grid Pane• Mobile JavaScript Button

mobile-NiagaraMobileWebApps The Niagara Mobile Web Apps component is a special App Folder that is configured to contain the

Niagara Mobile Web Apps. This container component behaves like a regular App Folder. It can contain additional apps that you install from its (default) App Manager view or by dragging and dropping apps onto the container in the nav tree.

mobile-MobilePropertySheetApp The Niagara Mobile Property Sheet App component provides access to a station’s property sheet

views. This component is available from the mobile module, under the NiagaraMobileWebApps container (drag and drop to add) or from the App Manager view (use the New button to add). With the

NiagaraAX-3.7

NiagaraAX Mobile Guide5–1

Page 36: NiagaraAX Mobile GuideDocshare01.docshare.tips/files/20865/208659378.pdfNiagaraAX-3.7 NiagaraAX Mobile Guide 1–3 Chapter 1 – Getting Started with NiagaraAXMobile NiagaraAX Mobile

Components in the mobile module Chapter 5 – Mobile Component Guides

August 16, 2012

Mobile Property Sheet, you can navigate up and down through the entire component hierarchy of your station, view and edit point files, and fire actions. See “About the Mobile Property Sheet App” on page 3-2 for more details.

mobile-MobileAlarmConsoleApp The Niagara Mobile Alarm Console App provides a mobile alarm console. This component is

available from the mobile module, under the NiagaraMobileWebApps container (drag and drop to add) or from the App Manager view (use the New button to add). The Alarm Console App allows to you view the current alarm counts for each of your alarm recipients, view any detail fields of individual alarms, acknowledge them, and add notes. See “About the Mobile Alarm Console App” on page 3-3 for more details.

mobile-MobileHistoryApp The Niagara Mobile Web Apps component provides access to history files and history views. This

component is available from the mobile module, under the NiagaraMobileWebApps container (drag and drop to add) or from the App Manager view (use the New button to add). With the Mobile History app, you can view history data in chart and table form. It supports delta mode as well as relative and specific time ranges, zooming (for charts) and column selection (for tables). See “About the Mobile Px App” on page 3-12 for more details.

mobile-MobileScheduleApp The Niagara Mobile Schedule App component provides access to scheduling views from a mobile

device. This component is available from the mobile module, under the NiagaraMobileWebApps container (drag and drop to add) or from the App Manager view (use the New button to add). The Mobile Schedule app supports touch-based editing of individual day schedules as well as special events, calendars, and trigger schedules. See “Mobile Schedule app Interface” on page 3-10 for more details.

mobile-MobilePxApp The Niagara Mobile Px App component allows standard Px pages to display on mobile devices. This

component is available from the mobile module, under the NiagaraMobileWebApps container (drag and drop to add) or from the App Manager view (use the New button to add). The Mobile Px app allows you to create your own Mobile Px pages using the existing Workbench Px editor, and have them convert on the fly into a mobile-friendly format. Many existing widgets are supported right out of the box, such as buttons, labels, sliders, and field editors, as well as some new ones. See “About Mobile Px views” on page 3-13 for more details.

mobile-BasicMobilePane The Basic Mobile Pane component provides a convenient set of simple features for use with mobile

Px page layout. The properties available with this pane (padding, rowGap, visible) help in the layout of menus and graphics for pages that are going to be displayed on a mobile device. The Basic Mobile Pane is available on the mobile palette.

mobile-MobileGridPane The Niagara Mobile Grid Pane component is a special pane that helps you design pages for mobile

devices. Properties in the Mobile Grid Pane property sheet allow you to created row and column spacing. The Mobile Grid Paned is located in the mobile palette under the Widgets folder.

mobile-MobileJavaScriptButton The MobileJavaScriptButton component is a button widget that can recognize JavaScript commands

when clicked. You can use the Px Editor to edit the JavaScript command for the button. The Mobile JavaS-criptButton is located in the mobile module in the Widgets folder.

NiagaraAX-3.7

NiagaraAX Mobile Guide5–2