1
Frame
2
Work
Web service client for iOS
Version 1.1.4
U S E R M A N U A L
© Taya & Niny 2014
12FrameWork - User manual
Content
IDEA
BEHIND
12FRAMEWORK
PURPOSE,
DESCRIPTION
AND
POSSIBLE
USE
CASES
ADDING
NEW
WEB
SERVICE
SETTING
PARAMETERS
FOR
CALLING
WEB
SERVICE
EDITING
WEB
SERVICE
STARTING
WEB
SERVICE
EDITING
WEB
SERVICE
RESULT
11
GENERAL
SETTINGS,
EXPORT,
IMPORT,
COLOR
THEMES,
ENCODING
AND
CUSTOM
BACKGROUND
12
14
ADDITIONAL
9
10
5
8
3
4
Page 2
12FrameWork - User manual
Idea
behind
12FrameWork
I started this app two years ago along with learning and mastering Objective C and Cocoa
Touch platform. I also have more than 15 years of experience in development of business
application for Microsoft Windows ™.
Main idea behind 12FrameWork is, to somehow connect that completely different platforms or more precisely, different worlds.
How it begins? My collegue works as a safety engineering manager for known European oil company and gets iPad from company. She asked me: »What useful for my job I can do with iPad/iPhone, except surfing, reading mail and playing games?« She travel a lot to company affiliates and she would like to have some useful schedule lists (directly from company databases), checklists for safety control, easy way to connect iPad images she made with corporate data and at last, to enter useful data directly to company database with iPad. Web browser apps are slow, far from comfortable and most important, not native (cannot use camera, location services etc). Developing native app is almost impossible, because IT (Information
Technology) sector of company do not develop for iOS devices. Why? It is not cost efective to hire iOS developer(s), purchase enterprise licence, and all that stuff only for couple of users.
On contrary, any existing IT can quickly make some useful web services and expose database tables to iOS users.
They only need appropriate web service client on iOS devices. And that’s where 12FrameWork jumps in.
So I decided to make this app with my friends and collegues, as universal, customisable, useful that will grow in features and reliability, with every new version and with every new user.
Thank you for using 12FrameWork
Milenko, Taya&Niny team
Page 3
12FrameWork - User manual
Purpose,
description
and
possible
use
cases
12Framework is a universal web service client for iOS, developed in Objective C.
It can be used for:
• Presenting data from web services in DataView, GridView or Text debug mode, with custom request parameters
• Appending, updating and deleting data on web services in custom dynamic forms, supporting text, bool, date, multiline text, pdf links, barcode reader and imagepicker controls.
• Shooting images and connecting them with database records
• Testing web services
12FrameWork offers easy export/import of webservices settings via email (also import settings from http location), protected by custom passcode.
Application is free to download and use. Adding new records and displaying more than 20 rows, are avaliable as a single InApp purchase.
Page 4
Adding
new
web
service
12FrameWork - User manual
12framework provides possibility to specify and call unlimited number of web services.
Click on + brings in input form for entering web service data, prefilled with some custom data (
WARNING: web
service settings data are case sensitive):
• Id is auto increment identificator for web service and cannot be changed
• Web service name is user define custom name of the web service
• Url for reading represents url to get data from server
• Url for writing represents url to post/write data to server
• Service type can be XML or JSON. XML offers sorted field order (dynamic form fields will be created in the same order as a table fields on database server), on the other side, JSON has unsorted field order
• Result encoding, encodes web service result to appropriate encoding.
Call type, it can be URL or HTTP post. URL means that all parameters are nested in http url line. With HTTP post, you can send parameters as custom http body.
Page 5
12FrameWork - User manual
Grid type can be:
• TableView, native iOS tableview control.
• GridView, experimental gridview component for displaying all fields data in a grid.
Parameters and param descriptions:
Define params for web service call. According to presented example, it's easy to define unlimited custom textedit, barcode, lookup or date field params for calling web service.
ID field:
Enter unique key field name for web service dataset. It is mandatory setting, otherwise insert, update and delete of particular record will not work.
Date format:
Enter date format compatible with your web service response
• Read suffix, suffix which will be added to »Url for reading«, when you get data from server, applies only for URL call type
• Update suffix, suffix which will be added to »Url for reading«, when you post updated data to server, applies only for URL call type
• Insert suffix, suffix which will be added to »Url for reading«, when you post inserted data to server, applies only for URL call type
• Delete suffix, suffix which will be added to »Url for reading«, when you post delete request to server, applies for URL call type only
• HTTP user name, user name for login on web server
• HTTP password, password for login on web server
Main node name, node in XML or JSON result which identifies one record from web service response
Page 6
12FrameWork - User manual
• Browse main field, field in XML or JSON result which will appear as a first label on TableView result
• Browse detail field, field in XML or JSON result which will appear as a second label on TableView result
• Field captions, after first call of web service, captions are filled with database field names and can be simply changed respectively
• Field controls, after first call of web service, control types are set as text fields. Can be changed to:
text,
memo, date, bool, imagepicker, pdf and barcode
(be careful of case sensitivity). Text is one row text component, memo is multirow text component, date invokes datepicker field, bool invokes switch for boolean fields (saves 1 for True and 0 for False to database field). Imagepicker is imageview field which displays image shooted on device camera according to web service result field. It saves image automatically to local application documents\image\service_id directory and posts image name to assigned database field. Camera invokes with double tap. Image name is formed with following pattern row_id_12frmYYYYMMDDHHMMSS.jpg
• Image, double tap and shoot appropriate image for your web service. It will then appear in web service list
• PDF, field must return HTTP link value, which creates or responses with PDF file
• BARCODE, barcode field triggers camera which scans barcode and write it in your service editbox.
Deleting web service
Simply swipe to left selected web service and tap on delete. It will immediately delete service without further warning.
Page 7
12FrameWork - User manual
Setting
parameters
for
calling
web
service
Examples: If you need static table with key value pair, declare list with key_value, for example:
1000_New York,2000_London,3000_Tokyo,4000_Moscow,5000_Melbourne...
Page 8
Editing
web
service
12FrameWork - User manual
If you want to change entries of web service, tap on gear button
After changing, save it with click on
Page 9
12FrameWork - User manual
Starting
web
service
Web service call starts with tap on play button
If Grid type is TableView, list of records from web service will be displayed.
WARNING: Free version is limited to display first 20 rows
only.
First label is what was set in Browse main field
Second label is what was set in Browse detail field
Tap on + sign (feature avaliable as InApp purchase), you add new record...
... and fill data.
For ID field is better, to let server side to assign the value, but you can type it anyway.
After typing values for some of avaliable fields, tap on checkmark to post data to web service.
You will be returned to previous list of records, with new record at the end of the list.
TableView refreshes after posting data, so if you see your record in list, it 100% exists in the server database.
Page 10
12FrameWork - User manual
Editing
web
service
result
Tap on one row...
... and app will display data ready for editing.
After changing values for some of avaliable fields, tap on checkmark to post data to web service.
TableView refreshes after posting data, so if you change browse main or browse detail field it will reflect changes immediately.
To delete record, tap on
After confirming, record will be deleted and TableView refreshes to reflect changes.
Page 11
12FrameWork - User manual
General
settings,
export,
import,
color
themes,
encoding
and
custom
background
Manual, shows this document on app internal viewer
Color theme, repaints all application views in choosed color scheme
Hide service editing, hides gear cannot edit existing web service settings
button so you
Record debug log, turn on this switch to begin recording log
Show log, if you have trouble calling your web service, or you want to see raw communication between application and web service,
Show tableview labels, if turned on, tableview will display also field name with field value.
No animation, turns off animation of forms and controls
Export services filter, when you add and set web services, you have to distribute settings to your users. Export filter enables exporting all services and one by one.
Export with passcode, sensitive web service settings data must be properly protected, thus enter custom passcode and tap on . Selected services will be exported to xml and packed to ZIP with typed passcode protection. Mail composer will be opened with prepared attachement
12fwservices.fwz and appropriate text, so you can enter email addresses and send settings. The other way is to send settings to yourself, open mail on computer and rename 12fwservices.fwz to 12fwservices.zip. Finally, put zip file on your secret HTTP location.
Export company logo, if you set custom company logo image url in settings, you can include it in your export services package. When user imports package, your company logo will automatically replace welcome page background.
Import URL location, enter URL location of exported ZIP
Page 12
12FrameWork - User manual package previously described and tap on ask you for type of import:
. App will
1. Drop existing (deletes existing services and append imported ones)
2. Add to existing (preserves existing services and append imported ones)
3. Update existing services (if local service ID exists in import package, local service with that ID will be completely replaced, otherwise it will be added as new one)
Import passcode, password used for export with passcode action
Device ID, identifier which represents last 10 characters of unique device ID. You cannot change this value. This value will be sent to server with every web service call.
Send ID to web service, if switched on, every request to web service will contain device id. It is useful for security reasons, so you can isolate your web service, to serve only previously approved devices.
Service list encoding, if you have to specify some special chars in web service declaration. Otherwise, use NSUTF8 string encoding.
Company logo url, enter url path for company logo image.
After that, when you jump to Welcome page, image will be downloaded and saved locally.
Refresh company logo, if you change url path, tap once on this button to reload logo image.
Reset services&settings, this action drops all services and resets settings to defaults.
Add test services, this action adds three test web services for presentation purposes.
Page 13
Additional
12FrameWork - User manual
Additional page offers InApp purchase Unlimited rows.
Buying removes 20 rows limit of reading data and
enables adding new records.
If you like this app, tell a friend or rate it in App Store.
Thank you.
About and support
This is about and support view. Tap on orange link to connect to 12framework website for further info or questions.
Thank you very much for using 12FrameWork!
Taya&Niny startup team
Page 14
