Orangescrum Mobile API Add on User Manual

2 Designed and Powered by
Table of Contents
How Can I install Mobile API add-on? .................................................................... 3
Requirements .................................................................................................. 3
Installation....................................................................................................... 3
Add-on Installation:-........................................................................................ 5
For Upgrading AddonInstaller:-........................................................................ 6
How can I use Mobile API to get access my app?................................................... 6
How can I generate my mobile access key/code?................................................ 13
What is my community URL?............................................................................... 14
What is my Login id & password for Mobile app?................................................ 15
What are features present in Mobile app? .......................................................... 15
What is the Play store link for Android app?........................................................ 16
What is the App store link for the iOS app? ......................................................... 16
Can I use this app for cloud (SaaS) edition? ......................................................... 16
How many users can use this mobile app? .......................................................... 16
Can I get regular updates for mobile app with the same price?........................... 16
Can I use both Android & iOS app with Mobile API? ............................................ 17
How can I install my Mobile API add-on?............................................................. 17

How Can I install Mobile API add-on?
Requirements
* Apache with `mod_rewrite`
* Enable curl in php.ini
* Change the 'post_max_size' and `upload_max_filesize` to 200Mb in
php.ini
* PHP 5.4 or higher and less than PHP 7
* MySQL 4.1 or higher
* If STRICT mode is On, turn it Off.
Installation
Below prerequisites need to be taken care of prior to installation.
The most important thing is if you have already purchased any add-on before
16th July 2016, then contact us at "support@orangescrum.org" before you
proceed to the following.
Note: If you have already installed the AddonInstaller before then no need to
install it again. Only exception is if you are finding any new version of installer or
you have not installed before then follow the below steps for successful and
seamless installation.
 Make sure to keep a backup of your existing "app" folder of your current
working directory.
 Extract the zip file(AddonInstaller-V1.0.zip) to your desktop.
 Remove the existing "app" folder from your working directory then copy
and paste the extracted "app" folder inside "AddonInstaller-V1.0" to your
working directory.

 If you are using local machine as storage (excluding Amazon S3), please
replace the folder, named "files" inside the "app/webroot" folder from the
back up to the current "app/webroot" folder.
 Give write permission to "app/Config", "app/tmp", "app/Plugin" and
"app/webroot" folders.
For Example:-chmod -R 777 app/Config
chmod -R 777 app/tmp
chmod -R 777 app/Plugin
chmod -R 777 app/webroot
 Import the "installer.sql" files from the extracted files to your current
database. If you have already imported installer.sql before then no need to
import it again. Only exception is if you are finding any new version of
installer.sql then import to your current database.
 Do necessary changes to "constants.php" and "database.php" inside
"app/Config" folder again as you have done earlier. For Example SMTP
email credentials in constants.php and database credentials in
database.php.
 Run your website once.
Ex. http://localhost/orangescrum (if you are using localhost)
http://127.0.0.1/orangescrum (if you are using IP)
http://myprojects.orangescrum.com (if you are using any valid domain)
Note: if you are facing any issue or seeing any blank page after doing all the above
steps, then just do the following once.

 Replace "Configure::write('debug',0);" with "Configure::write('debug',2);"
in the app/Config/core.php. Run the web url once and restore the debug
value to 0 again.
i.eConfigure::write('debug',0);
Congratulations!!
Add-on Installation:-
 Download the Add-on zip file.
 Place the downloaded zip file(Ex. Timelog-V1.0.zip) in the "app/webroot"
folder.
 Log in to the application.
 To install the add-on(Ex. Time log add-on) run below link once and follow
the instructions.
Ex. http://..../install/timelog (for Time Log add-on)
Note: http://.... means your Orangescrum access URL.
Ex. http://localhost/orangescrum (if you are using localhost)
http://127.0.0.1/orangescrum (if you are using IP)
http://myprojects.orangescrum.com (if you are using any valid
domain)
 Do the same for other add-ons.
Ex. http://..../install/invoice (for Invoice add-on)
http://..../install/taskstatusgroup (for Task Status Group add-
on)
http://..../install/ganttchart (for GanttChart add-on)
http://..../install/recurringtask (for Recurring Task add-on)

http://..../install/api (for API add-on)
http://..../install/chat (for Chat add-on)
http://..../install/clientmanagement (for Client Management
add-on)
http://..../install/projecttemplate (for Project Template add-
on)
Note: you can find notification.js, node-js-installation-linux.pdf, node-js-
installation-windows.pdf file in app/plugin folder after install the chat plug-in.
For Upgrading AddonInstaller:-
 Download the AddonInstaller zip file.
 Before installing updated AddonInstaller, make sure to keep a backup of
your existing "app/Plugin" and "app/webroot/files" folders.
 Then follow the steps written above to install AddonInstaller.
 After installing the new AddonInstaller, Copy all the folders inside
"app/plugin" backup folder to the new "app/Plugin" folder.
 Also copy all the folders inside "app/webroot/files" backup folder to the
new "app/webroot/files" folder.
How can I use Mobile API to get access my app?

Mobile API will help you to generate the API access token to use the mobile app.
To generate the access token:
 Go the Company Settings under Setting
 Click on My Company
 Navigate to API Access Token & Click on Generate
 Click on Update
Install the Orangescrum Mobile App from the Play store or App store.
Select “Yes” as you’re an existing user.

Tap on the “I am a Community/Enterprise User”.

Now enter your Orangescrum URL on your desktop with the following format:
 If you’re using localhost: http://localhost/orangescrum/api/v2.0/
 If you’re using IP: http://127.0.0.1/orangescrum/api/v2.0/
 If you’re using any valid domain:
http://myproject.orangescrum.com/api/v2.0/

Note: Ensure you enter the right protocol – http or https as applicable
Enter your API Access Token in Access Code on your mobile app.

You can see the Sign in Page. Use your credential of your account to sign in or if
you’re using Google Sign in; use the Google Sign in button.

Once you logged in, you can see your projects and tasks.

How can I generate my mobile access key/code?
Go to Settings >Company Settings>My Company> to generate an API Access
Code. Check Page 2 for more detail steps.

What is my community URL?
After you download Orangescrum, you need to host it though localhost or IP or a
domain. Your community URL will be look like:
 If you’re using localhost: http://localhost/orangescrum
 If you’re using IP: http://127.0.0.1/orangescrum
 If you’re using any valid domain: http://myproject.orangescrum.com
For the below given image, the community URL is http://newui.orangescrum.org

What is my Login id & password for Mobile app?
The email id & password is same as you used for your Orangescrum account. If
you’re using Sign in with Google account, then do same here in mobile app.
What are features present in Mobile app?
The Mobile App lets you:
 View the project listing of all your assigned projects
 Task listing of each project
 Create & assign tasks on the go
 Post comments and updates to tasks
 Edit, delete & change the status of tasks
 Search Project & Tasks
 Check task updates, indulge in discussions, and adjust schedules, spot tasks
on the go

What is the Play store link for Android app?
You can install the Orangescrum Mobile App for Android by searching
Orangescrum from Play store Or here is the link for Orangescrum:
https://play.google.com/store/apps/details?id=com.andolasoft.orangescrum&hl=
en
What is the App store link for the iOS app?
You can install the Orangescrum Mobile App for iPhone/iPad by searching
Orangescrum from App store or here is the link for Orangescrum:
https://itunes.apple.com/ph/app/id1132539893
Can I use this app for cloud (SaaS) edition?
Yes, but not at the moment. Once we release the app, you can see the option to
use it for community or cloud edition. You need to select which edition you want
to use.
How many users can use this mobile app?
There is no limit to use the mobile app for community users. However for SaaS
(cloud) users, the limit depends on the pricing plan.
Can I get regular updates for mobile app with the same price?
Yes, you will get regular updates. Check Play Store or App Store for the update.
Also you can subscribe to our blog to get regular updates about Orangescrum new
features, add-on updates. You can check the roadmap or Mobile API add-on
Release Note of the add-on too.

Can I use both Android & iOS app with Mobile API?
Yes, you can. And the access key or code will be same for both iOS & Android.
How can I install my Mobile API add-on?
Please download the Zip file after purchasing the add-on. Extract the file, you can
see the README.md file. If you face any issue, feel free to reach us at
Support@orangescrum.com.

Orangescrum Mobile API Add on User Manual

More Related Content

What's hot (16)

Similar to Orangescrum Mobile API Add on User Manual (20)

More from Orangescrum (20)

Recently uploaded (20)

Orangescrum Mobile API Add on User Manual