Customer: Arinum Solutions. Project: Sircle.

Transcription

1 Customer: Solutions Project: Sircle

2 Document Owner: Munira Abbas Date: 09 December Version: 2.0 Documents Control Notice to the Recipient of this Proposal The information contained here in is considered proprietary and confidential information of Solutions Pty Ltd and its release would offer substantial benefit to competitors offering similar services. This material includes descriptions of methodologies and concepts derived through substantial research and development efforts undertaken by Solutions. Therefore, the use or release of the information contained in this proposal for purposes other than an evaluation of its contents as a basis for contract award is prohibited, and it is the position of Solutions that the materials herein are not considered subject to release under the Freedom of Information Act, if applicable. No part of this proposal may be reproduced by any means or transmitted without the prior written permission of Solutions except with respect to copies made or transmitted internally by you for the purpose of evaluating this proposal. All copies of this proposal (or any portion hereof) and any accompanying electronic copies should be returned to Solutions or, at Solutions option, destroyed at the end of the proposal evaluation period if Solutions are not selected. No part of this document may be modified, deleted or expanded by any process or means without prior permission from Solutions. Neither submission by Solutions nor your acceptance of this proposal, in whole or in part, constitutes acceptance by Solutions of any contractual terms contained in your Request for Proposal, if any, and shall not form a binding agreement between the parties. Such an agreement shall only exist upon the execution of a mutually acceptable contract by both parties. Except as otherwise set forth in such a contract, Solutions makes no representations or warranties to you. This proposal is being submitted only by Solutions, which is solely responsible for its contents, and Solutions shall be the contracting entity if its proposal is selected Inspire.Integrate.Innovate contact@arinum.com Page 1

3 Sircle Document Control Version Developer Date Document Write 1.0 Tyler Yang Tyler Yang 2.0 Ted Wong Amy Xin Inspire.Integrate.Innovate Page 1

4 Table Of Content 1. Overview 2 2. Introduction 2 3. Sircle Production Site Backend IOS Application Different User Types Community Admin 2. IOS / Android a. Home b. Calendar c. Photos d. Notifications e. Newsletters f. Documents g. Links h. Videos i. Forms j. Settings k. Feedback l. Sign Out 6. Web-Serves 5 Inspire.Integrate.Innovate contact@arinum.com Page 1

5 Overview This guide is an introduction to Sircle mobile app development. It will guide you through both the app platforms development and the web backend that supports and feeds the apps. The backend is based on the LAMP stack with both the Apps developed natively. Introduction The web portal allows the administrator of an instance to manage the content that flows into the app. All content can be controlled through the web portal and 2 modules (calendar, notifications) can be additionally controlled by the ios app and 1 module (notifications) can be controlled by the Android app as well. There are 2 sites, one for development and one production. All work is carried out on the development site and tested throughly before it is migrated to the production site and retested again. At this stage the production site is not a clone of the test site. This is due to certain developments on the production site, and certain unfinished features on the test site. Both sites have FTP and myphpadmin access. Development: Production: Inspire.Integrate.Innovate contact@arinum.com Page 2

6 Sircle Production Site The production site have a domain prefix to distinguish which client is using Sircle. For example, `sircle` is the domain prefix, which is our own demo account. All the school production site can be found in the Sircle Umbrella page: Backend The backend of the web portal is written in php with CodeIgniter framework, and using MySQL database. You can ask your colleagues for information of each FTP login, they will give you the authentication for FTP and MySQL database. IOS and Android Application The ios and android app is basically an extension of the web portal, which allows you to use same set of functionality on mobile phone. IOS app development is ahead to android. There are some modules that are present in IOS but not yet in android. You can download all the school apps and our testing app in app store, simply searching in app store. The application has two type of users: 1. Community 2. Admin Different User Types: Community User It is for parents, or other community members who are interested in the school news and information.they do not have any admin rights. So no push notifications or add calendar events from the application it self. Admin User It is for school s staff/admin to use only. As they get full control.they can post a notification to notify the `Community` user. They can also add,delete and edit event in the calendar. If the school is using a third party calendar Like SENTRAL GOOGLE OR KAMAR the app does show the edit calendar functionally. This is to reduce the risk of multiple information in calendar. As sircle only does one way sink. Inspire.Integrate.Innovate contact@arinum.com Page 3

7 Also, a special admin user is created while application is generated, called apple apple This is for Apple ios s submission process only. This username/password have the admin right. After app has been approved, this account needs to be disabled. Inspire.Integrate.Innovate contact@arinum.com Page 4

8 Web-Servers The ios and Android application will communicate with the web-server via JSON, and all the related setting will be stored in the `schoolname`-prefix.pch file. They have a path define there. Please note the JSON data needs to be passed to the web service in a named value pair p_data. See code example at the end of this document. Sircle uses a post based webservice. Sample request to webservice from android String url= ; JSONObject j = new JSONObject(); j.put("cmd", "method name"); j.put("data", data); HttpClient httpclient = new DefaultHttpClient(); HttpPost httppost = new HttpPost(url); Deleting an event Sample request to webservice from android String url= ; JSONObject j = new JSONObject(); j.put("cmd", "delevent"); j.put("data", server_event_id); HttpClient httpclient = new DefaultHttpClient(); HttpPost httppost = new HttpPost(url); Sample data data = 1333;//server_event_id response: true or false Updating an event Sample request to webservice from android String url= ; JSONObject j = new JSONObject(); j.put("cmd", " addevent"); j.put("data", data); HttpClient httpclient = new DefaultHttpClient(); Inspire.Integrate.Innovate contact@arinum.com Page 5

9 HttpPost httppost = new HttpPost(url); Sample data = { action = 0; begin = " "; category = 4; content = "Special Details"; date_link = ""; end = " "; end_time = "15:45:00"; grade = " "; location = "Special Place"; pid = 0; reminder = "48:00:00"; repeat_end = " "; repeat_end_occurrences = 0; repeat_every = 1; repeat_on = 0; repeat_type = 0; server_id = 1333;// This differentiate add event and update event start_time = "13:30:00"; status = 0; subject = "Special Event 2"; type = ev; xid = 0; }; Response: { cmd = addevent; cmd_status= 1; data = { server_id = 1333; }; } Adding an event Sample request to webservice from android String url= ; JSONObject j = new JSONObject(); j.put("cmd", "addevent"); j.put("data", data); HttpClient httpclient = new DefaultHttpClient(); HttpPost httppost = new HttpPost(url); Inspire.Integrate.Innovate contact@arinum.com Page 6

10 Sample data data = { action = 0; begin = " "; category = 0; content = ""; date_link = ""; end = " "; end_time= "06:00:00"; grade = " ";// grade list would be in local sqlite database location = ""; pid = 0; reminder = "48:00:00"; repeat_end = ""; repeat_end_occurrences = ""; repeat_every = 1; repeat_on = 0; repeat_type = 0; start_times = "06:00:00"; status = 0; subject = "Sample Data"; type = ev; xid = 0; }; Response: server event id Detailed description about Event fields begin: Start date end: End date Start_time: start time End_time:end time Category: server category id(this is already in the local database) Content:description Subject:title Location: location Reminder:calendar event reminder Type:ev,ph,sh,al ev: Normal Event ph: Public Holiday( fields need to pass type:ph, subject:, start_date: ) sh:school Holiday( Inspire.Integrate.Innovate contact@arinum.com Page 7

11 fields need to pass type:sh, subject:, start_date:, end_date ) al: same as ev Recurring event fields action = 0; "date_link" = ""; pid = 0; "repeat_end" = " "; "repeat_end_occurrences" = 0; "repeat_every" = 1; "repeat_on" = 0; "repeat_type" = 0; The above fields represent recurring event. Further details would be explained later as it needs more explanation. Notification Sample request to webservice from android String url= ; JSONObject j = new JSONObject(); j.put("cmd", " sendmessage "); j.put("data", data); HttpClient httpclient = new DefaultHttpClient(); HttpPost httppost = new HttpPost(url); Sample data data = { grade = ( 1, 2, 3, 4, 5, 6, 99 ); "msg_content" = "Test Content"; "msg_subject" = "Test Subject"; Inspire.Integrate.Innovate contact@arinum.com Page 8

12 }; tweet = 1;// indicate whether this notification updates the twitter as well String url= ; 1)First solution String cmd= syncconfig ; String selector= "3" JSONObject j = new JSONObject(); j.put("cmd", cmd); j.put("data", selector); HttpClient httpclient = new DefaultHttpClient(); HttpPost httppost = new HttpPost(url); List<NameValuePair> namevaluepairs = new ArrayList<NameValuePair>(2); namevaluepairs.add(new BasicNameValuePair("p_data", j.tostring())); httppost.setentity(new UrlEncodedFormEntity(nameValuePairs)); HttpResponse response = httpclient.execute(httppost); String json = EntityUtils.toString(response.getEntity()); Log.d("check data", json); 2)Second solution String cmd= geteventlist ; String selector= "null" JSONObject j = new JSONObject(); j.put("cmd", cmd); j.put("data", selector); HttpClient httpclient = new DefaultHttpClient(); Inspire.Integrate.Innovate contact@arinum.com Page 9

13 HttpPost httppost = new HttpPost(url); List<NameValuePair> namevaluepairs = new ArrayList<NameValuePair>(2); namevaluepairs.add(new BasicNameValuePair("p_data", j.tostring())); httppost.setentity(new UrlEncodedFormEntity(nameValuePairs)); HttpResponse response = httpclient.execute(httppost); String json = EntityUtils.toString(response.getEntity()); Log.d("check data", json); If both fails i think it may be a server side issue Inspire.Integrate.Innovate contact@arinum.com Page 10

14 Things To Keep In Mind Cross version Issues on ios Because the company wants to support as more user as possible, so the ios project is deployment target the ios 5, with the base SDK is ios 7. So, the application need to be careful when using old APIs and least API. Remember to use a `respondtoselector` to avoid potential crash in the application Automatic Reference Counting Basically, it mixed with ARC and non-arc in the same project. But it is suggest to use ARC for least development and application maintenance. As I previous maintainer of this project, I strongly suggest that you use ARC, and move all the codes to ARC. Third Party Libraries The project used LOTS of third party libraries, and some may have some issues. If you find some error that it is not likely to happen, it maybe because of the third party libraries. NOTE: Please make a note and come up with a way to replace all third party libraries. Inspire.Integrate.Innovate contact@arinum.com Page 11