Um-en

Version 67 (Rok Lenardic, 28 October 2010 03:35 pm) → Version 68/70 (Rok Lenardic, 28 October 2010 03:39 pm)

*ENGLISH USER MANUAL*

{{toc}}

h1. Sign Up

To sign up for a *free account* and give the application a spin, navigate to http://app.acquee.com/designer/signup . The new account will grant you access to the Designer Application where forms can be designed, lists uploaded and various settings configured.

> _*Note:* Mobile user accounts will be managed inside the application and do not need to be opened separately at the above address._

h1. Designer Application

Once you have opened an account, navigate to the http://app.acquee.com/designer/login and use the credentials to log in.

h2. Home

Upon login, the home screen will be shown:
!01_home.png!

A few things are displayed here:
* *main menu* on the left
* *dashboard* in the middle of the screen from where you can see:
** any pending notifications
** some account statistics
** active forms/surveys (forms that are not retired)
** links to active form design and result view

The *explanation of the usual workflow* of how to use the application follows below.

h2. Creating your first form

To create and manage your forms/surveys, click on the *Forms* menu item on the left which will display the list of all existing forms:
!03_browse_forms.png!

To create your first form click the *Create new* button and follow the steps outlined below.

h3. Editing basic information

When creating or editing a form use the *[Basic Info]* tab to enter essential information and properties of a form:
!04_create_new_form.png!

For starters, enter only basic information such as:
* *Title* - a name of the form used as an internal identifier
* *Public* - leave this checkbox enabled to make the new form publicly available without having the user to authenticate; the URL will be displayed after the form is saved
* *Compatibility Mode* - select _HTML Only_ in case you will be using older phones that have limited Javascript & Ajax support or leave it to _Automatic_ otherwise

The tabs available at the top of this screen offer the following functionality
* *[Basic Info]* - to create a new form or edit basic information of existing ones
* *[Design]* - to create and manage screens and fields
* *[Publish]* - to grant access to a form to mobile users
* *[Results]* - to view and export collected results
* *[Analyze]* - to graphically present collected results of some structured fields

h3. Designing pages and fields

Move onto the *[Design]* tab, click the *Add screen* button and enter the first page''s title:
!05_new_screen.png!

We''ll keep our form simple and be satisfied with only one page at this time *but*:
# notice the black rectangle with a 1 in it on the left, those are page tabs
# if you add more pages, you will see more page tabs
# you can select the page by clicking on its tab
# you can rearrange pages by simply dragging and dropping the tabs around

Clicking the *Add field* button, will give you a dialog where the title and the type of the field is selected:
!06_new_field.png!

Click the new field positioned on the top of page 1:
!07_field_properties.png!

# the field receives *focus* indicated by the red outline
# *field properties* are shown in a column on the right

Let''s do two things:
# enable the *Mandatory* checkbox
# enter the multiple *Options* that should be offered to the user, separated by new line (enter/return), as shown in the screenshot above

Do not forget to *Save*!

Let''s add another field, of type _Yes/No_ this time, asking the user if _they currently own a car_:
!08_another_field.png!

h3. Sharing the Form

Switch to *[Publish]* tab to see the following:
!09_form_publish.png!

Keep in mind the following facts:
# Since you have enabled the *Public* property of the form, the form does not need to be published (assigned) to any user. It is publicly available through the listed *URL*.
# Your free account comes with *ONE authenticated mobile user* that is shown here. However, the password of this user has not been set yet and you will be able to do so within the *Mobile Users* menu item. But since it is a public form, ignore this for the moment.
# additional authenticated mobile users can be purchased within the *[Subscription]* tab of the *Account* menu item

To access the mobile form now, simply enter the URL shown in this screen into your mobile device (PDA, cellphone, etc).

h2. Submitting results

The above URL should be navigated to using your mobile device to see something like:
!11_mobile_form.png!

You can also use a desktop browser to submit it.

See the [[Um-en#Mobile-Application|Mobile Application]] section below for more details on the mobile interface.

h2. Viewing results

Once you had submitted a few forms, navigate to the *[Results]* tab to see the outcome:
!12_results.png!

Options available are:
* view results *grouped by submit* or *raw*
* export results to *Excel* or *CSV*
* click *Search* button on the grid to filter results
* click *Delete* to permanently erase displayed results and use the filters to narrow down selection

Switch to *[Analyze]* tab now and select one of the questions from the dropdown to display a nice graphical representation of the results:
!13_analyze.png!

h2. Manage Mobile Users

Your free account comes with *ONE authenticated mobile user*. However, the password of this user is not set yet so you will have to do so within the *Mobile Users* menu item. Select the _Free User_ and the following screen will allow you to set its properties:
!14_mobile_users.png!

Set the user''s Full Name, Username and Password. This user will be able to *access assigned forms in an authenticated manner*.

Additional authenticated mobile users can be purchased using the *[Subscriptions]* tab within the *Account* menu item.

> *Note*: *Free User*''s form submissions count towards the quota of the free account (*20 form submissions / month*). Additional *purchased mobile users do not have any limitation* on the number of form submissions.

h1. Mobile Application

When we refer to the mobile application, we refer to the form entry interface, authenticated or un-athenticated.

h2. Unauthenticated access

Forms that are set as *Public* can be accessed directly by simply entering its URL into the mobile or desktop device''s browser (see [[Um-en#Editing-basic-information|Editing basic information]]).

h2. Authenticated access

Forms that are not public will require a few prior setups:
# mobile user(s) must have a username and password set (see [[Um-en#Manage-Mobile-Users|Manage Mobile Users]])
# form access must be granted to individual mobile users (see [[Um-en#Sharing-the-Form|Sharing the Form]])
# the URL, and login credentials must be sent to mobile users (URL and account code required can be retrieved from the home/dashboard screen, account code is also visible under the *Account* menu item of the Designer application)
!15_dashboard.png!

When the user navigates to the corresponding URL, she is presented with the mobile login screen where mobile user''s credentials must be entered:
!16_mobile_login.png!

Once logged in, the mobile home screen is shown listing all available forms that were granted to the logged in user:
!17_mobile_home.png!

To start entering a form, the user must only click on the name of the form.

h2. Form entry

To see the example of the form entry we have designed, see [[Um-en#Submitting-results|Submitting results]]. However, notice that the bottom toolbar has another cancel button that can be used to cancel the entry and go back to the home screen:
!18_authenticated_form_entry.png!

According to our previous definition of the form, the first field is a multiple selection with an orange/red background which indicates a mandatory input and the second one is a Yes/No.

More about the mobile application features and field types can be found on http://acquee.com/en/features/#mobile .

h1. Lists

Lists are long spreadsheets of data that should be viewable or selectable within a survey/form. To avoid tedious manual input, Acquee offers import of such data in *Excel* or *CSV* formats.

h2. Creating lists

First of all, navigate to the *Lists* menu item. Here, a few options are available:
!19_lists.png!
* *Create new* open an editing screen to enter list details
* *Clear selected* empties all records of selected list(s) but does not delete its core definition
* *Delete selected* deletes all records and the selected list(s) itself

Click the *Create new* button and fill in the necessary data:
!02_new_lists.png!
* give the list a *Name*
* submit an *XLS* or *CSV* file which will automatically be parsed by the application (in this case, select the "Country List Excel file found "here":http://forge.acquee.com/attachments/13/country_list.xls )
* after clicking *Save* the system may take a while to upload, parse and import the submitted list so be patient

h2. Managing lists

The following actions are available for lists inside Acquee:
* permanently remove a list (*Delete list* button)
* delete all records of a list (*Clear list*) - this option should be used before an updated version of a list needs to be loaded
* view list items using the *[List items]* tab
* see which forms a list is used on by a field using the *[Used on Forms]* tab
* editing list items is not supported in Acquee

h2. Form fields based on lists

> *Note*: Form fields that are based on lists will only if *Compatibility mode* of a form is NOT set to _HTML Only_!

To create a form field that allows the user to select from a list, go to the *[Design]* tab of the *Forms* screen and click the *Add field* button:
!20_field_list_create.png!

* Enter the field''s *Title*
* select its *Type* as _List_.

Then, select the newly created field in order to set its properties:
!21_field_list_properties.png!

* select _Country List_ under *Choose a List*
* set *Enable list browse* option
* do not forget to *Save*!

When filling in the form now, there will be a third field that you can start typing in for the application to offer you autocomplete options (countries) that match the entered string:
!22_mobile_list_field_autocomplete.png!

Clicking the *magnifying glass icon* next to the input box will pull up the field browse/search dialog of all countries:
!23_mobile_list_field_browse.png!

h2. Excel/CSV file rules

* Import files *MUST* contain at least *TWO* columns, the Key and the Name column. Additional *optional columns* can also be included.
* Keys must be *UNIQUE* within one list.
* Header line is optional, use the *Contains header line* checkbox to set it accordingly.
* Additional/optional columns are text only (numbers will be imported as text as well).
* The number of additional columns apart from Key and Name is not limited, however, keep in mind that the mobile interface becomes cluttered easily with too much information.

Use some of the sample import files to test the List functionality:
* "Inventory Sample List XLS":http://forge.acquee.com/attachments/12/cycling_parts_inventory.xls
* "Country List XLS":http://forge.acquee.com/attachments/13/country_list.xls
* "Asset Locations CSV":http://forge.acquee.com/attachments/15/rooms.csv