SA-Announce Cloud Services Mobile Notifier User Manual: ios and Android Version 1.0.0

Transcription

1 SA-Announce Cloud Services Mobile Notifier User Manual: ios and Android Version 1.0.0

2 About Syn-Apps Syn-Apps L.L.C. was founded in 2001 as a consulting firm focused on developing software for IP telephony platforms. Since that time, Syn-Apps has evolved as a market leader in enterprise-wide paging and notification solutions designed to improve business processes, increase safety, and streamline internal and external communication. Since 2001, over 2,000 organizations have integrated our notification software with phones, paging systems, IP speakers, and hundreds of other internal systems and services. Syn-Apps has an extensive knowledge base in numerous development technologies. In addition, Syn-Apps has a strong background in network design and networking fundamentals. We believe this combination of experience in a broad range of technologies allows us to offer our customers an end-to-end application development solution. We believe that in order to have a successful application deployment, one should not only understand the development environment, but also understand how the application will interact with the rest of network. Syn-Apps has extensive networking experience based on a number of network development and design projects for many Fortune 100 companies. We believe that this enables us to become a valuable asset to any development team. Syn-Apps developers have a wide variety of development experience in many diverse industries. Our developers have been employed by, or consulted for companies such as Oracle, Microsoft, Cisco, General Motors, General Dynamics, Bloomberg, and many others. All of our developers have a keen understanding of the software development life cycle and know how to develop successful applications. At Syn-Apps we understand the importance of a team environment and are comfortable developing and sharing information to ensure that the best of breed product is produced.

3 Contents 3 Table of Contents Part 1 Syn-Apps Mobile Notifier 5 Part 2 Mobile Notifier - Administrator Guide 7 1 System... Requirements 7 2 Network... Requirements 8 3 Mobile... Commands Supported 9 Mobile Notifier... Tem plates 10 4 SA-Announce... Cloud Services 11 5 Creating... Groups in SA-Announce 13 6 Mobile... Notifier User Interface Settings 15 7 Using... the Mobile Notifier User Interface 17 Part 3 Syn-Apps Mobile for ios - End User Guide 20 1 Download... Installation for ios 20 2 App Registration... for ios 21 3 Using... Syn-Apps Mobile on your ios device 22 Part 4 Syn-Apps Mobile for Android - End User Guide 28 1 Download... and Installation for Android 28 2 App Registration... for Android 29 3 Using... Syn-Apps Mobile on your Android Device 30 Part 5 Help and Support 33 1 Documentation Knowledge... Base 34 3 Prepare... Report 35 3

4 Syn-Apps Mobile Notifier Part 1

5 Syn-Apps Mobile Notifier 1 5 Syn-Apps Mobile Notifier Introduction Syn-Apps Mobile empowers organizations with the ability to instantly send alerts containing text, audio, video, graphics, photos, and maps from virtually anywhere to enabled smartdevices. The application provides powerful feedback capabilities, allowing recipients to respond to notifications in a variety of ways. The respond feature(s) provide administrators the ability to coordinate quicker action plans by capturing, monitoring, and responding to situations as they occur. This user guide consists of two primary sections, one for administrators and one for mobile application recipients, (end-users). The Mobile Notifier - Administrator Guide discusses how to select and remove mobile recipients from SA-Announce Cloud Services notification groups, as well as configuring registered endpoints using the the Mobile Notifier user interface. The Syn-Apps Mobile for ios and Syn-Apps Mobile for Android sections are written for mobile application recipients to understand how to install, register, and use the Syn-Apps Mobile app on their smartdevice(s). Syn-Apps Mobile is currently available for ios and Android smartdevices. This guide assumes SA-Announce or higher has already been installed and configured with an active Cloud Services license. If it has not previously been configured, please refer first to the SA-Announce User Manual for additional installation and configuration. Contact Syn-Apps Sales for additional details.

6 Mobile Notifier Administrator Guide Part 2

7 Mobile Notifier - Administrator Guide 2 7 Mobile Notifier - Administrator Guide This chapter includes a brief overview discussing general navigation of the commands supported by the Mobile Notifier, SA-Announce Cloud Services user interface, as well as general navigation and settings required when using the Mobile Notifier user interface. 2.1 System Requirements This section provides an overview of the System Requirements for SA-Announce and Cloud Services. For full requirement details, visit the SA-Announce User Manual. Server Requirement Description Software Requirements Supported Versions Operating System Windows Windows Windows Windows Microsoft.NET Microsoft.NET SP2 (32-bit or 64-bit versions) 2008 R R2 (64 bit) *Automatically installed if the server has internet access (or download here) [Included with Windows 2008 R2] Microsoft SQL Server Microsoft SQL Server 2008 R2 SP1 or greater is required for redundancy and Cloud Services. Hardware Requirements Server hardware minimum requirements listed below CPU Any dual core processor (minimum recommended) Memory 2 GB of system memory (minimum requirement) Hard Drive 10 GB of hard drive space (minimum requirement) Syn-Apps Mobile Notifier Requirement Description SA-Announce or above SA-Announce is required in order for the Mobile Notifier to receive notifications Mobile Notifier User Interface Setup The Mobile Notifier Service setup program. The SA-Announce Configuration Utility will download and install the Mobile Notifier service and the web user interface into IIS, such that no intervention is required. Consult Syn-Apps Support if the SA-Announce configuration utility does not properly download and install the Mobile Notifier. Internet Connection The Mobile Notifier requires internet connection.

8 8 2.2 Cloud Services User Manual: Syn-Apps Mobile Network Requirements Consult the table below to determine which ports need to be opened to allow proper operation. Network Requirements Description Port 443 All Cloud Services Notifiers require access to the internet thru SSL (Secure Socket Layer) via HTTPS, port 443. Internet Connection Mobile Notifier requires internet connection. Communicating between the Mobile Notifier and SAAnnounce Port 8008 Both SA-Announce and the Mobile Notifier use Port 8008, (default), to communicate with each other. This communication is bi-directional. This is only required to be open to the outside when the Mobile Notifier and SAAnnounce are running on separate servers. Communicating between the Mobile Notifier and SAAnnounce Cloud Port 443 Mobile Notifier uses Port 443 to communicate to SA-Announce Cloud. Address Mobile Notifier uses Host URL *.cloudapp.net to communicate to SAAnnounce Cloud. Communicating between the Mobile Notifier and Android Push Server Port 443 Mobile Notifier uses Port 443 to communicate with the Android Push Server. Host URL Mobile Notifier uses to communicate to the Android Push server. Communicating between the Mobile Notifier and ios Push Server Port 2195 Mobile Notifier uses Port 2195 to communicate with the ios Push Server Push Host URL Mobile Notifier uses to communicate to the ios Push server. Port 2196 The ios Push Server uses Port 2196 to communicate back to the Mobile Notifier. Feedback Host URL The ios Push Server uses to communicate back to the Mobile Notifier.

9 Mobile Notifier - Administrator Guide Mobile Commands Supported The Syn-Apps Mobile Notifier is configured to send rich content to Mobile Notifier recipients, which are assigned on the Mobile Notifier server. When a notification is received from SA-Announce, the Mobile Notifier will form an HTML message to deliver to mobile endpoints configured in the SA-Announce notification group. The following SA-Announce Announce commands are supported by the Mobile Notifier: SA-Announce Command Description Text Messages Mobile Notifier sends text to registered smartdevices. Images Mobile notifier supports images notification sent from SAAnnounce. Stored Audio A Stored Audio Command will be placed into the template. This directs a media player element in the template to play the audio file at the URL pointed to by the stored audio command. Stored Video A stored video command can be placed into the template. This directs a media player element in the template to play the video file at the URL pointed to by the stored video command.

10 Cloud Services User Manual: Syn-Apps Mobile Mobile Notifier Templates This section explains the basic structure of the Mobile Notifier template(s). To access the Mobile Notifier Template, navigate to C:\Program Files (x86)\syn-apps\mobilenotifier\templates\template.html. To modify any of the following text, Template HTML Replacement Text Description %TITLE% The Mobile Notifier will replace %TITLE% with the notification title text. %BODY% The Mobile Notifier will replace %BODY% with the notification body text. %PROMPT% The Mobile Notifier will replace %PROMPT% with the notification prompt text. %TYPE% The Mobile Notifier will replace %TYPE% with the notification type text. This can be used as a switch in script to react differently to each notification type while using a single template file. Valid types include: Emergency Alerts AMBER Alerts Weather Alerts Text Messages The Mobile Notifier Template allows a user to customize content elements included in notifications. To access, navigate to C:\Program Files (x86)\syn-apps\mobilenotifier\templates\template.html. Note: We recommend starting with a copy of the original Template HTML file when creating a unique template with additional items, (such as images, audio, and video). A copy of the template file ensures the original template is not replaced. See the following table for further instructions: Additional Content Elements Description Image0.png The Mobile Notifier will place the primary notification image in the root of the package with the name Image0.png. The primary image will always be included in a notification.**note - The image0.png should not be altered because it carries the dynamic image file delivered by SA-Announce. **AMBER Alerts include an image of the victim, provided one is available. URL Audio Admins may add a URL that references audio, which is used with the template. Note: Certain notification groups, such as Emergency Alert groups, already contain audio. These notification groups that contain audio already will play, in addition to the URL audio added to the template. Be sure to use a group type that does not contain any associated audio. URL Video Users can add URL referenced video to the template.

11 Mobile Notifier - Administrator Guide 2.4 SA-Announce Cloud Services This section explains how to access the Mobile Notifier via the SA-Announce Cloud Services user interface. Login to the SA-Announce user interface using the User name and Password created when installing and configuring SA-Announce. 11

12 12 Cloud Services User Manual: Syn-Apps Mobile Cloud Services All available Cloud Services Notifiers can be found in the SA-Announce user interface by navigating to: Groups >> Create / Edit Groups >> Cloud Services tab of a previously created Paging Group. Please refer to the SA-Announce User Manual for more information about creating Paging Groups. Note: Each Notifier has its own user interface. Do not confuse the two user interfaces. The Notifier UI is completely different from the SA-Announce UI. The Notifier UI is designed specifically to manage registered endpoints and various settings while the SA-Announce UI controls the notification groups and endpoints associated with the notification group(s). 1. Before viewing specific Notifier endpoints in the SA-Announce UI, use the Select Group to Edit dropdown list and choose the correct notification group. It is important to select a specific group first because each group may have different Notifier endpoints associated with the group. If a group has not been created before, an authorized user must create a group. 2. The blue MobileNotifier(1) link will display the number of associated endpoints in brackets (x). For example, the screenshot shows MobileNotifier(1). This means there is only one Mobile Notifier endpoint associated with the 7800_EmergencyAlert SA-Announce notification group. 3. Click on the MobileNotifier in the Available Recipient Modules table to open the Mobile Notifier user interface. Users may view, modify, or delete notifier endpoints from a specific notification group in the Mobile Notifier UI. 4. Once Cloud Services endpoints are configured, authorized users may send SA-Announce notifications. See your SA-Announce User Manual for directions on sending SA-Announce notifications.

13 Mobile Notifier - Administrator Guide Creating Groups in SA-Announce Groups >> Create / Edit Groups >> General Groups must first be created in SA-Announce before assigning Mobile Notifier endpoints. The standard notification group setup process is described in this section. For information on creating different group types, refer to the appropriate SA-Announce User Manual. To create a new group select Groups >> Create / Edit Groups >> General. Click New Group button located in the bottom-left of the application.

14 14 Cloud Services User Manual: Syn-Apps Mobile Configure the following settings for the new group: Notification Group Setting Description Enter a Group Name Enter a descriptive name for the group. Group Type Select a group type. A Normal notification group type is recommended. Refer to your SA-Announce User Manual >> SA-Announce Notification Group Types section for details on additional group types. Server Group* Use with the Redundancy feature. Select the server group where this notification should reside. Select <None> to run the group on the publisher. This field will only be editable if the redundancy subsystem has been configured. Group Phone Settings Line Number Dial the extension to activate the notification group. SA-Announce will suggest the next available line number however users must ensure that their call manager is configured to route this line number to SA-Announce. An alternative method would be entering a unique number to generate a specific line number. Partition* The partition the group phone belongs to. For example, phones hones must have a CSS containing this partition to be able to dial the group. Device Pool* The device pool the phone belongs to. The Device Pool must be set such that callers receive a G.711 codec lookup. Misc Settings Use Security Code When checked, an additional field is presented. Enter a DTMF security code to secure the group. Initiators are required to enter the DTMF security code before the notification can continue. Send Caller-ID IP phone screens within the selected group will receive the initiators' caller ID. Emergency Enable to send text and audio stream to busy phones. Volume* The Volume drop-down menu allows users to adjust the volume of audio on IP phone speakers. The Default volume setting uses the setting of each phones' speaker individually. Other settings, such as 90% and 80%, override the current volume setting on the phone and forces the phone to play the audio at the percentage of maximum volume specified. IP speakers can be made to use the groups volume setting by adjusting the speakers volume to 0 in the IP Speaker configuration table Settings >> IP Endpoint Setup >>Syn-Apps IP. While this does affect the volume of phones, it does not affect the volume of External Phones, Legacy IP devices, or Alertus notifications. Group Opening Tone Group Opening Tone Send a predefined audio notification tone to destination end-points. Select an opening tone to be played. For live audio group types, the caller confirmation tone will be played once the opening tone completes. * Feature may vary across SA-Announce platforms. Ignore this setting if your SA-Announce user interface does not list this setting. Click Add Group. The group can be saved, although endpoints have not been associated. Endpoints can be configured after saving the group. Click the Save Group button to save changes.

15 Mobile Notifier - Administrator Guide Mobile Notifier User Interface Settings Mobile Notifier User Interface Settings SA-Announce >> Groups >> Create/Edit Groups >> Cloud Services >> MobileNotifier >> Mobile Notifier UI >> Settings The SA-Announce Configuration Utility will download and install the Mobile Notifier service and the web user interface into IIS, such that no intervention is required. Consult Syn-Apps Support if the SA-Announce configuration utility does not properly download and install the Mobile Notifier. The Mobile Notifier user interface will open in a new window. The Notification Recipients tab will be shown by default. For first time setup, all configurations will be handled by the SA-Announce Configuration Utility. No further action is required. To view or re-configure, authorized users should click on the Settings tab to verify the Mobile Notifier Integration Settings are accurate and set for the system to operate properly. To modify these settings, use the Settings tab and modify the available fields. The settings will be saved and the Mobile Notifier Service will restart and use the new settings. Mobile Notifier Settings Description Fields Account ID This is the account ID provided by Syn-Apps with an active Mobile Notifier subscription. Authorization ID This is the account authorization key that is encrypted and provided by Syn-Apps for entry into the configuration utility.

16 16 Cloud Services User Manual: Syn-Apps Mobile SA-Announce Settings The following are back-end settings used by SA-Announce for Mobile Notifier MobileNotifier.exe.cofig file: SA-Announce IP The IP address used by Mobile Notifier to communicate with SAAnnounce. SA-Announce Port This is the Port SA-Announce is running on. It is also used by the Mobile Notifier to communicate with SA-Announce. GUI Address The IP address of the Mobile Notifier UI. The web GUI is used to assign endpoints to notifications and configure settings. IP The Mobile Notifier IP address. It is used by SA-Announce to find the Mobile Notifier when there is a notification. Port The Port which the Mobile Notifier runs on. It is used by SAAnnounce to find the Mobile Notifier when there is a notification.

17 Mobile Notifier - Administrator Guide Using the Mobile Notifier User Interface Notification Recipients tab SA-Announce >> Groups >> Create/Edit Groups >> Cloud Services >> MobileNotifier >> Mobile Notifier UI >> Notification Recipients Use the Mobile Notifier UI to add available Mobile endpoints to an SA-Announce notification group. Select endpoints in the Available list using the double-right arrow button >> to move the highlighted endpoints to the Selected list. To remove endpoint(s) from the Selected list, click to highlight the endpoints and use the doubleleft arrow button << to move the endpoint back to the Available list. Standard Windows Ctrl-Click and Shift-Click can be used to select endpoints. Use the Filter button to search for endpoints in either list. Use the Order By dropdown list to re-arrange the endpoints' order either by Name or ID first. Click the Save button to save the Notifier endpoints for a specific notification group. The Mobile Notifier will automatically close after the selection has been saved. An example of the Mobile Notifier user interface is shown below:

18 18 Cloud Services User Manual: Syn-Apps Mobile Refresh the SA-Announce UI page. Choose the appropriate group from the Groups to Edit dropdown list. The changes made in the Notifier Recipients page will now appear. Click Save Group button to save the endpoints associated with the notification group. A red notification will appear at the bottom of the screen stating changes are active and saved correctly. To update the endpoint count in the parentheses, refresh the SA-Announce UI page (F5) and re-select the group you changed. The changes made in the Notifier Recipients page will now be reflected in the endpoint count. Once Cloud Services endpoints are configured, authorized users may send SAAnnounce notifications. See your SA-Announce User Manual for directions on sending SA-Announce notifications. Note - If there are no Mobile endpoints associated to an SA-Announce notification group, (denoted as MobileNotifier( )), it is most likely because endpoints have not been added in the Mobile Notifier user interface OR there have been no end-users that have downloaded and registered the Syn-Apps Mobile Application on their smartdevice. Successful Notification The Syn-Apps Mobile Notifier obtains a list of registered mobile endpoints from the Syn-Apps Cloud Services every sixty seconds. Each third party push service must be authenticated with Syn-Apps. Currently, only Apple ios and Google Android third party push services integrate with Syn-Apps Mobile. Android devices use user names and passwords to register with Syn-Apps. Apple devices use a SSL (secure sockets layer) certificate to register with Syn-Apps. When the Mobile Notifier receives a notification from SA-Announce, it will add an entry to the Mobile Notifier log that the alert was received successfully. When a notification is received from SA-Announce, the Mobile Notifier will form an HTML message to deliver to mobile endpoints configured in the SA-Announce notification group.

19 Syn-Apps Mobile for ios - End User Guide Part 3

20 20 3 Cloud Services User Manual: Syn-Apps Mobile Syn-Apps Mobile for ios - End User Guide Syn-Apps Mobile is available to download for free from the itunes App Store. The app is compatible with iphone, ipad, and ipod touch with ios 6.0 and above. This chapter explains the installation, registration, and directions on how to use the mobile application by end users. 3.1 Download Installation for ios For first time users, open the App Store on your ios device. 1. Search for Syn-Apps Mobile. 2. Click the Download icon.

21 Syn-Apps Mobile for ios - End User Guide App Registration for ios 1. Open the application after the download completes. 2. A message will pop up asking if you want Syn-Apps Mobile to use your location. Click OK to allow. **Note: Location Services must be enabled for Request Assistance to work. 3. You must register your device by typing in the Account Name. The account name is provided by your organization. Reach out to your IT department if you are unsure of the account name. Click Register. On the next page, fill in your First Name, Last Name, and Phone Number in the provided fields. Click Finish to complete registration.

22 Cloud Services User Manual: Syn-Apps Mobile Using Syn-Apps Mobile on your ios device Syn-Apps Mobile Home Screen After Registration completes, you will be re-directed to the Syn-Apps Mobile Home screen. This is the screen you will use to view Notifications and Notification History. To view a notification, click on the notification or click on the blue arrow to open. To view or modify your settings, click the Settings button in the top-left corner of the home screen. To delete notifications in your home screen, click the Edit button in the top-right corner and click the Delete icon (located on the image attached to the notification). Alternatively, swipe your finger from right-to-left and click Delete.

23 Syn-Apps Mobile for ios - End User Guide 23 Viewing a Notification The notification(s) will contain information sent from your organization. Each notification may include a combination of the following: an image, audio sound (which will override your phone's volume, even if on silent mode), and text detailing the notification's purpose. To return to the Notification Home screen, click the Notifications button in the top-left corner. Responding to a Notification After viewing the notification, you can respond by clicking the Actions button in the top-right corner of the application. Users can respond by clicking the Send Confirmation, Send Photo, Send Video, or Send Text buttons.

24 24 Cloud Services User Manual: Syn-Apps Mobile Send Confirmation The Send Confirmation button is used when you want to acknowledge you received the notification from the initiator. After clicking the Send Confirmation button, a confirmation button will appear on your ios device, indicating your response was successfully sent. Click OK to exit and return back to the notification. To send an additional response, click the Actions button again and select a new response button. Please note the Send Confirmation button may only be used once, while the other response options can be used multiple times for the same notification.

25 Syn-Apps Mobile for ios - End User Guide 25 Send Photo & Send Video The Send Photo and Send Video buttons are similar to use, so they are both described in this subsection. Click either of the buttons and capture the photo or video. Click the Use Photo or Use Video button after capturing the image/video. Click the Retake or Use Photo/Video button to send the attachment. After clicking the Send Photo/Video button, a confirmation button will appear on your ios device, indicating your photo or video was successfully sent. Click OK to exit and return back to the notification. To send an additional response, click the Actions button again and select a new response button.

26 26 Cloud Services User Manual: Syn-Apps Mobile Send Text The Send Text button is used to respond to the notification with a message to the initiator. Type your message into the text box and click the Send button in the top-right corner. A confirmation button will appear on your ios device, indicating your text was successfully sent. Click OK to exit and return back to the notification. To send an additional response, click the Actions button again and select a new response button.

27 Syn-Apps Mobile for Android End User Guide Part 4

28 28 4 Cloud Services User Manual: Syn-Apps Mobile Syn-Apps Mobile for Android - End User Guide Syn-Apps Mobile is available to download for free from the GooglePlay. The app is compatible with Android devices 3.0 and above. This chapter explains the installation, registration, and directions on how to use the mobile application by end users. 4.1 Download and Installation for Android For first time users, open the Google Play store on your Android device. 1. Search for Syn-Apps Mobile. 2. Click the Install button.

29 Syn-Apps Mobile for Android - End User Guide App Registration for Android 1. Open the application after the download completes. 2. A message will pop up asking if you to accept application permissions. Click Accept. 3. You must register your device by typing in the Account Name. The account name is provided by your organization. Reach out to your IT department if you are unsure of the account name. Click Register at the bottom of the screen. On the next page, fill in your First Name, Last Name, and Phone Number in the provided fields. Click Finish to complete registration.

30 Cloud Services User Manual: Syn-Apps Mobile Using Syn-Apps Mobile on your Android Device Syn-Apps Mobile Home Screen After Registration completes, you will be re-directed to the Syn-Apps Mobile Home screen. This is the screen you will use to view Notifications and Notification History. To view a notification, click on the notification. To view or modify your settings, click the More (...) button >> Settings button in the top-right corner of the home screen. To delete notifications in your home screen, click on the notification from the list and hold down to delete a notification.

31 Syn-Apps Mobile for Android - End User Guide 31 Viewing a Notification The notification(s) will contain information sent from your organization. Each notification may include a combination of the following: an image, audio sound, (which will override your phone's volume, even if on silent mode), and text detailing the notification's purpose. To return to the Notification Home screen, click the Android "back" button on your device. Responding to a Notification After viewing the notification, you can respond by clicking the Confirm button at the bottom-center of the application. Send Confirmation The Confirm button is used when you want to acknowledge you received the notification from the initiator. After clicking the Confirm button, the Confirm button will turn grey and becomes unusable. Click the Android Back button to exit and return back to the notification home screen.

32 Help and Support Part 5

33 Help and Support 5 Help and Support The following sections describe the Help section of the SA-Announce user interface. Contact Syn-Apps Technical Support on the web at support@syn-apps.com or call >> Select option Documentation Help >> Documentation The Help >> Documentation page contains the SA-Announce User Guide in a PDF format. 33

34 Cloud Services User Manual: Syn-Apps Mobile Knowledge Base Help >> Request Support >> Knowledge Base The Request Support page contains a Knowledge Base and Prepare Report links. Consult the Knowledge Base tab to find articles pertaining to current issues. Feature requests can also be submitted here. To add Feature Requests, click the Request Support link in the left pane. A new page will open. In the Problem Type drop-down list, select Feature Request. Fill in the remaining required fields and then click the Send Support Request button.

35 Help and Support Prepare Report Help >> Request Support >> Prepare Report The Request Support page contains a Prepare Report tab that can be used to generate a Syn-Apps Technical Support request. This is the preferred method to obtain support because all the log files will be automatically sent to Syn-Apps Support. A Support Ticket will be generated for the case. FTP access is required for the process to work automatically. To request support please fill out the following information in the interface provided on the page: Prepare Report Field Description Contact Address Enter the address of the person Syn-Apps Support should contact in response to this trouble ticket. Contact Phone Number Enter the phone number of the person Syn-Apps Support should contact in response to this trouble ticket. Detailed Description Enter a detailed description of the problem in the provided text box, provide as much detail as possible as to how the problem is occurring.

36 2812 N Norwalk Suite 112 Mesa, AZ Phone: (866) Fax: (866) sales@syn-apps.com