Orangescrum In App Chat Add-on User Manual

2 Designed and Powered by
Table of Contents
How can I install chat add-on?............................................................................... 3
Requirements ..................................................................................................... 3
Installation.......................................................................................................... 3
Add-on Installation ............................................................................................. 5
For Upgrading AddonInstaller:-........................................................................... 6
For Install Node.js............................................................................................... 7
How can I use or start conversation with my users?.............................................. 9
What are the features in the chat? ...................................................................... 11
Chat with User:................................................................................................. 11
Chat with Team:................................................................................................ 13
Save as Task:..................................................................................................... 15
Share Files:........................................................................................................ 15
Real-time availability: ....................................................................................... 16
User Role: ......................................................................................................... 17
Which users will be available for chat? ................................................................ 18
Can I chat with my clients? .................................................................................. 18
How can I create a group in chat?........................................................................ 19
How can I check my recent conversation?........................................................... 21
How can a user know if I send a message? .......................................................... 21

How can I install chat 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/chat (for Chat add-on)
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.

For Installing Node.js
There are 4 simple steps to install Node.js on your server. These are as follows:
1. Install Node.js and NPM
2. Install socket.io using NPM
3. Install Forever
4. Run the notification.js (given with the chat add-on) file forever using the
“Forever”. (it should not stop)
Note: You can find the notification.js file in app/plugin folder after install the chat
plug-in.
Download node.js from below URL
https://nodejs.org/en/download/
 Click on the downloaded Node.js "Windows Installer" (.msi package.) (32-
bit/64-bit).
 Double click on the "node-v4.4.7-x86.msi" file to start installation process
and then follow the instructions.
 After successful installation of Node.js open node command line interface.
To open node command line:
 Go to windows "Start Menu" and type "Node" in the search box.
 Click on "Node.js command prompt".
 It will open up a command prompt.
 Now run the following command to install the socket.io
npm install socket.io
 After Install socket.io run following command to install forever
npm install forever -g

 After installed all the above step please copy and paste the "notification.js"
file (given with the chat add-on) in the same directory where the
node_modules is installed (Ex. C:UsersAndolasoft).
Run the below command to start node.js.
forever notification.js
Now node server is ready. You can test by checking the below url
http://your-domain:3002
Ex. http://localhost:3002
http://127.0.0.1:3002
http://myorange.com:3002
If output is "Welcome to socket.io." then node.js is working fine and you can use
that url in the constant.php as "NODE_HOST"
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 plugin .
If you’re still facing the installation problem, then feel free to reach us at
support@orangescrum.com.
* **Official website**:
[http://www.orangescrum.com](http://www.orangescrum.com)
* **Blog**: [http://blog.orangescrum.com](http://blog.orangescrum.com)

* **Downloads**: [http://www.orangescrum.org/free-
download](http://www.orangescrum.org/free-download)
* **Issue Tracker**:
[https://github.com/Orangescrum/orangescrum/issues](https://github.com/Oran
gescrum/orangescrum/issues)
* **Google Group**: [https://groups.google.com/group/orangescrum-
community-support](https://groups.google.com/group/orangescrum-community-
support)
How can I use or start conversation with my users?
 Login to Orangescrum
 Go on the chat icon (you can find it at the bottom right corner near
the + icon)
 Click on the chat icon
 On the chat pop-up, go to the search bar & search the name of the user.

 Click on that user & type your message to start the chat or conversation
with him or her.

What are the features in the chat?
Chat with User:
 Login to Orangescrum
 Go to the chat icon (you can find it at the below right corner near the
+ icon)
 Click on the chat icon
 On the chat pop-up, go to the search bar & search the name of the user.

 Click on that user & type of your message to start the chat or conversation
with him or her.

Chat with Team:
 Click on the chat
 Go to the Group icon
 Search user & click on every user to add them to group

 Click on the Create Group
 Edit the Group Name from the Group tab on the left side of the chat pop-up

Save as Task:
 On the chat pop-up, go to the top right corner.
 Click on the Save as Task
 Select the Project & an existing task or create a new task from here
 Click on Save to Create the conversation as Task or to add it to existing
Task.
Share Files:
 Go to the message description box, click on the attach icon.
 Attach the file & send it to the user or team

Real-time availability:
If a user is logged in Orangescrum, then you can see the user is live/online as a
green light on his or her profile icon or image.

User Role:
You can see a user is admin or owner or client or a general user. If on the below of
the user icon or image is not mentioned anything, then the user is a general user.
Other users marked as client, admin or owner as role given by the owner or
admin. You can see if a user is admin, then it will show you admin on the below of
his or her profile icon or image.

Which users will be available for chat?
With chat add-on, all users in your company added in Orangescrum will be
available to your chat user list. You can chat with any user including your clients
here.
Can I chat with my clients?
Yes, you can chat with your clients here. When you search the name it will show
you at the below of user name whether he is the client or a general user in case
you have user and client have same name.

How can I create a group in chat?
 Click on the chat
 Go to the Group icon
 Search user & click on every user to add them to group
 Click on the Create Group
 Edit the Group Name from the Group tab on the left side of the chat pop-up

 Start your conversation with your team

How can I check my recent conversation?
Go to the Left side of your chat pop-up & click on the Recent to check the recent
conversation.
How can a user know if I send a message?
Once you send a message the user will get a desktop notification if he is signed in
Orangescrum. If the user is logged out, (s)he can see themessage when (s)he can
login to the system. The message count will show on the chat icon.

Orangescrum In App Chat Add-on User Manual

More Related Content

What's hot (20)

Similar to Orangescrum In App Chat Add-on User Manual (20)

More from Orangescrum (20)

Recently uploaded (20)

Orangescrum In App Chat Add-on User Manual