Recent changes to User Guide

WikiPage User Guide modified by Sam Daignault

Sam Daignault — Fri, 22 Mar 2013 22:38:04 -0000

--- v5
+++ v6
@@ -19,65 +19,39 @@
 8. Load PuTTY, and create a new session, populating the server field with your login name and the server IP.
 9. Expand SSH tree on the left hand side, select Auth. Where it notes, browse to your key file and select it. Return to the main menu and save your session.
 10.    If you followed the steps correctly, you should be connected to the server via SSH, if you can’t connect, repeat the steps above and double check to make sure you have done everything correctly. Once you have successfully connected to the server, please DELETE the key that was originally provided to you.
+
+Connecting to the Server via VNCviewer/Remote Desktop
+----------------------------------------------------
+1. Download VNCviewer from this link http://www.realvnc.com/download/viewer/
+2. Open Putty
+3. Add Hostname: 54.235.178.20 and save a new session 
+4. In the category menu on the left expand SSH and select Tunnel.
+5. Add the Source port 5901 and the Destination localhost:5901 and click Add
+6. In the category menu on the left select Session and click Save
+7. Click Open
+8. Log in with the credentials provided by your administrator
+9. Open VNCviewer and enter the VNC Server: localhost:5901 and click Connect
+10.    enter the VNC credentials provided by your administrator and click OK
+11.    You are now connected to the server via VNCviewer! Have fun!
+
  
 #Android User Guide
-Launching the App
-------------------
-After installing the app on your device, launch the app from the main menu.
-
-Registering
-------------
-a. To register a new account, click the “Register” button on the login screen. All fields must be entered. In addition, the password and confirm password fields must be the same, and you cannot register an email that is already in use by another user. If any of the before mentioned cases occur, the appropriate error message will be displayed. To cancel your registration click the cancel button, and you will be returned to the login screen.
-b. If registration is successful, a dialog box with your business ID appears. This should be kept in a safe place, as it is needed every time you and employees in your business log in.
-
-

 Logging In
 ------------
 To login, enter your registered email address, password, and business ID. If you attempt to login with invalid credentials, you will be notified with an error message. In addition, if you are offline, you must have logged in at least once with your account whilst being online. Furthermore, you must have logged in online not more than 3 days ago or you will be unable to log in.

-Creating an Employee
----------------------
-a. If you have the appropriate permission, you will have the “Create Employee” option on the main menu. Select it to continue.
-b. Fill in all the fields, and select one or more permissions that the user will have. These can be changed later. When everything is satisfactory, click the add button. The user will be added to your business, and an email will be sent to the specified email address with their password. To cancel adding the employee, click cancel.
-
-Editing an Employee
+Creating a Sales Call
 ----------------------
-a. If you have the appropriate permission, you will have the “Edit Employee” option on the main menu. Select it to continue.
-b. You will be shown a list with the names of all employees in your business. Select the employee you wish to edit.
-c. Edit the employee’s information and then click save. All fields are required and there must be at least one permission checked. To cancel all changes click the cancel button. Additionally, if you make changes to your own account, you must log back in.
-
-Removing an Employee
---------------------
-a. If you have the appropriate permission, you will have the “Remove Employee” option on the main menu. Select it to continue.
-b. You will be presented with a list of employees that are in your business. Tap the one you wish to remove
-c. You will be asked if you are sure that you want to delete the employee. If you select yes, the employee will be deleted and you will be returned to the main menu.
-Note: You cannot delete your own account.
-
-Creating a Sales Call
----------------------
-a. If you have the appropriate permission, you will have the “Create Sales Call” option on the main menu. Select it to continue.
+a. Select “Create Sales Call” from the main menu.
 b. You will be shown a list with the regions that your business operates in. Select the region you are in.
 c. You will be shown a list with the pharmacies in the selected region. Select the pharmacy you are in.
-d. The sales call creating screen will be displayed. To add products click the add product button. Select the product that you are reporting on from the drop down. Enter the inventory that the pharmacy has for that product in the inventory field. If the all is satisfactory for the product in the pharmacy, choose yes for the fronted option. If not, select no and enter the details in the Notes field. The resupplied option is the amount that was restocked during the call (if any). If nothing was restocked, enter 0. If there are no notes necessary, type “None” or something similar. When all is satisfactory, click add. You will be returned to the main sales call screen. You can continue to add products until you are finished, or edit existing entries by tapping on them. Once complete, click “Close” to save the sales call to the server, or leave the sales call by going back. The sales call will automatically be saved to your device if you leave the call without closing it.
+d. The sales call creating screen will be displayed. To add products click the “Add Product” button. Select the product that you are reporting on from the drop down. Enter the stock that the pharmacy has for that product in the “current stock” field. Enter the number of that product that are facing out on all of the shelves combined. When you are finished, click the check mark at the top of your screen. You will be returned to the main sales call screen. You can continue to add products until you are finished, or edit existing entries by tapping on them. Once complete, click “Close Call” to save the sales call to the server, or leave the sales call by going back or clicking the home button. The sales call is saved automatically each time you add a product.
+Viewing Sales Call History
+-----------------------------
+a. From the main menu, either select “Open Sales Calls” or “Closed Sales Calls”
+b. If you selected “Open Sales Calls”, select a sales call and then make the necessary changes. If you selected “Closed Sales Calls”, you will be able to view, but not edit, any sales calls that have been saved to the server.

-Viewing Sales Call History
-----------------------------
-a. If you have the appropriate permission, you will have the “Sales Call History” option on the main menu. Select it to continue.
-b. You will be presented with a list of your closed sales calls (if any). This cannot be edited, only viewed. To view sales calls that are still open, click “View Open Sales Calls”
-c. Open sales calls can be edited. Tap on the call you wish to edit.
-d. Once you have made the necessary changes, you may close it, or go back. If you choose to close it, the call will be removed from the open sales calls section.
-
-Managing Your Business
------------------------
-a. If you have the appropriate permission, you will have the “Manage Business” option on the main menu. Select it to continue.
-b. Here you can change the following information about your business:
-   - Business Name
-   - Business Owner
-   - Address
-   - Phone Number
-c. Once you have made the necessary changes, click save.
-d. You may also delete your business. If you do so, all of your business information will deleted from the database, including employees, sales calls, etc. Since your account will also be deleted, you will be logged out.

 #iOS User Guide

WikiPage User Guide modified by Sam Daignault

Sam Daignault — Thu, 21 Feb 2013 04:40:05 -0000

--- v4
+++ v5
@@ -21,18 +21,63 @@
 10.    If you followed the steps correctly, you should be connected to the server via SSH, if you can’t connect, repeat the steps above and double check to make sure you have done everything correctly. Once you have successfully connected to the server, please DELETE the key that was originally provided to you.
  
 #Android User Guide
+Launching the App
+------------------
+After installing the app on your device, launch the app from the main menu.

-> Notes:
-You may skip step 2 if you have already created an account.
-The app prototype will show the user their business ID in the app directly.
+Registering
+------------
+a. To register a new account, click the “Register” button on the login screen. All fields must be entered. In addition, the password and confirm password fields must be the same, and you cannot register an email that is already in use by another user. If any of the before mentioned cases occur, the appropriate error message will be displayed. To cancel your registration click the cancel button, and you will be returned to the login screen.
+b. If registration is successful, a dialog box with your business ID appears. This should be kept in a safe place, as it is needed every time you and employees in your business log in.

-1. Launch app from Android device: 
-2. Register a new account by clicking the “Register” button. All fields must be entered. In addition, the password and confirm password fields must be the same, and you cannot register an email that is already in use by another user. If any of the before mentioned cases occur, the appropriate error message from the server will be displayed. To cancel your registration click the cancel button, and you will be returned to the login screen. 
-3. Login using the email address and password you registered. If you just created an account, you can find your business ID in LogCat (Windows > Show View > Other > Android > LogCat). Look for a line that looks similar to:
-“results”:{business_id”: 64}.
-If you attempt to login with invalid credentials, you will be notified with an error message from the server. In addition, if you are offline, you must have logged in at least once with your account whilst being online. Furthermore, you must have logged in online not more than 3 days ago or you will be unable to log in.
-4. Once you have logged in, you will be presented with the main menu. Currently only the “Log Out” button has been implemented. When it is clicked, it disconnects your session with server and returns you to the login screen.
-5. To exit the application, click “Exit” from the main menu.
+
+
+Logging In
+------------
+To login, enter your registered email address, password, and business ID. If you attempt to login with invalid credentials, you will be notified with an error message. In addition, if you are offline, you must have logged in at least once with your account whilst being online. Furthermore, you must have logged in online not more than 3 days ago or you will be unable to log in.
+
+Creating an Employee
+---------------------
+a. If you have the appropriate permission, you will have the “Create Employee” option on the main menu. Select it to continue.
+b. Fill in all the fields, and select one or more permissions that the user will have. These can be changed later. When everything is satisfactory, click the add button. The user will be added to your business, and an email will be sent to the specified email address with their password. To cancel adding the employee, click cancel.
+
+Editing an Employee
+----------------------
+a. If you have the appropriate permission, you will have the “Edit Employee” option on the main menu. Select it to continue.
+b. You will be shown a list with the names of all employees in your business. Select the employee you wish to edit.
+c. Edit the employee’s information and then click save. All fields are required and there must be at least one permission checked. To cancel all changes click the cancel button. Additionally, if you make changes to your own account, you must log back in.
+
+Removing an Employee
+--------------------
+a. If you have the appropriate permission, you will have the “Remove Employee” option on the main menu. Select it to continue.
+b. You will be presented with a list of employees that are in your business. Tap the one you wish to remove
+c. You will be asked if you are sure that you want to delete the employee. If you select yes, the employee will be deleted and you will be returned to the main menu.
+Note: You cannot delete your own account.
+
+Creating a Sales Call
+---------------------
+a. If you have the appropriate permission, you will have the “Create Sales Call” option on the main menu. Select it to continue.
+b. You will be shown a list with the regions that your business operates in. Select the region you are in.
+c. You will be shown a list with the pharmacies in the selected region. Select the pharmacy you are in.
+d. The sales call creating screen will be displayed. To add products click the add product button. Select the product that you are reporting on from the drop down. Enter the inventory that the pharmacy has for that product in the inventory field. If the all is satisfactory for the product in the pharmacy, choose yes for the fronted option. If not, select no and enter the details in the Notes field. The resupplied option is the amount that was restocked during the call (if any). If nothing was restocked, enter 0. If there are no notes necessary, type “None” or something similar. When all is satisfactory, click add. You will be returned to the main sales call screen. You can continue to add products until you are finished, or edit existing entries by tapping on them. Once complete, click “Close” to save the sales call to the server, or leave the sales call by going back. The sales call will automatically be saved to your device if you leave the call without closing it.
+
+Viewing Sales Call History
+----------------------------
+a. If you have the appropriate permission, you will have the “Sales Call History” option on the main menu. Select it to continue.
+b. You will be presented with a list of your closed sales calls (if any). This cannot be edited, only viewed. To view sales calls that are still open, click “View Open Sales Calls”
+c. Open sales calls can be edited. Tap on the call you wish to edit.
+d. Once you have made the necessary changes, you may close it, or go back. If you choose to close it, the call will be removed from the open sales calls section.
+
+Managing Your Business
+-----------------------
+a. If you have the appropriate permission, you will have the “Manage Business” option on the main menu. Select it to continue.
+b. Here you can change the following information about your business:
+   - Business Name
+   - Business Owner
+   - Address
+   - Phone Number
+c. Once you have made the necessary changes, click save.
+d. You may also delete your business. If you do so, all of your business information will deleted from the database, including employees, sales calls, etc. Since your account will also be deleted, you will be logged out.

 #iOS User Guide

WikiPage User Guide modified by Sam Daignault

Sam Daignault — Mon, 19 Nov 2012 01:10:37 -0000

--- v3
+++ v4
@@ -1,3 +1,5 @@
+[Return Home](https://sourceforge.net/p/ndas/wiki/)
+
 **User Guide**
 ==============
 [TOC]

WikiPage User Guide modified by Sam Daignault

Sam Daignault — Wed, 14 Nov 2012 23:41:05 -0000

--- v2
+++ v3
@@ -1,3 +1,51 @@
 **User Guide**
 ==============
+[TOC]
+
+#Generating a PuTTY Compatible Private Key and connect to the Server
+
+
+Note: if you are not using PuTTY, you do not need to follow these steps. You may just connect using the SSH command and including the name of your keyfile inside the command with the appropriate flags.
+
+1.	Once you have received your private key from your System Administrator,  [download PuTTYgen](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) and Pageant if you will be making SSH connections outside of PuTTY, for SCP or SFTP for example.
+2.	Run puttygen.exe
+3.	Click Conversions -> Import key
+4.	Select your Private Key:  
+5.	Your key will now be loaded into the utility 
+6.	Optional: Enter a passphrase for the keyfile where noted, this adds an extra layer of security and forces the user to enter a password every time they try to use it.
+7.	Click Save Private Key, and save the .ppk file on your computer in a safe location. Feel free to store it on as many devices as you please, but make sure they are in your own secure possession
+8.	Load PuTTY, and create a new session, populating the server field with your login name and the server IP.
+9.	Expand SSH tree on the left hand side, select Auth. Where it notes, browse to your key file and select it. Return to the main menu and save your session.
+10.	If you followed the steps correctly, you should be connected to the server via SSH, if you can’t connect, repeat the steps above and double check to make sure you have done everything correctly. Once you have successfully connected to the server, please DELETE the key that was originally provided to you.
+ 
+#Android User Guide
+
+> Notes:
+You may skip step 2 if you have already created an account.
+The app prototype will show the user their business ID in the app directly.
+
+1.	Launch app from Android device: 
+2.	Register a new account by clicking the “Register” button. All fields must be entered. In addition, the password and confirm password fields must be the same, and you cannot register an email that is already in use by another user. If any of the before mentioned cases occur, the appropriate error message from the server will be displayed. To cancel your registration click the cancel button, and you will be returned to the login screen. 
+3.	Login using the email address and password you registered. If you just created an account, you can find your business ID in LogCat (Windows > Show View > Other > Android > LogCat). Look for a line that looks similar to:
+“results”:{business_id”: 64}.
+If you attempt to login with invalid credentials, you will be notified with an error message from the server. In addition, if you are offline, you must have logged in at least once with your account whilst being online. Furthermore, you must have logged in online not more than 3 days ago or you will be unable to log in.
+4.	Once you have logged in, you will be presented with the main menu. Currently only the “Log Out” button has been implemented. When it is clicked, it disconnects your session with server and returns you to the login screen.
+5.	To exit the application, click “Exit” from the main menu.
+
+#iOS User Guide
+
+1.	Login to the CISX Server and Launch Xcode
+2.	Open the NDAS Project from recent projects. (This is a fully integrated copy of the code. All iOS code has been merged into this trunk).
+3.	Select iPhone 6.0 Simulator next to the stop button.  
+4.	Click Run  
+5.	The Project will build. Click on the Create New Business Button.
+6.	Fill out the form.
+7.	Click the Register the Business Button
+8.	Click Login Button
+9.	Enter the information for the account you just created.
+10.	Select Sign in.
+11.	If the code is successful, you will move to a new screen. If not, you will be presented with an error Dialog.
+ 
+
+
 [Return Home](https://sourceforge.net/p/ndas/wiki/)

WikiPage User Guide modified by Patrick McCallen

Patrick McCallen — Sun, 11 Nov 2012 20:46:06 -0000

--- v1
+++ v2
@@ -1,2 +1,3 @@
 **User Guide**
 ==============
+[Return Home](https://sourceforge.net/p/ndas/wiki/)

WikiPage User Guide modified by Patrick McCallen

Patrick McCallen — Sun, 11 Nov 2012 20:43:52 -0000

**User Guide** ==============