Table of Contents. 2 Designed and Powered by

Transcription

1 User Manual

2 Table of Contents How Can I install Recurring Task add-on?... 3 Requirements... 3 Installation... 3 Add-on Installation: For Upgrading AddonInstaller: How can I create Recurring Task?... 7 Recurring Pattern... 8 Daily Recurring... 8 Weekly Recurring... 8 Monthly Recurring... 9 Yearly Recurring Start Date Occurrences End Date Designed and Powered by

3 How Can I install Recurring Task 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. 3 Designed and Powered by

4 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 credentials in constants.php and database credentials in database.php. Run your website once. Ex. (if you are using localhost) (if you are using IP) (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. 4 Designed and Powered by

5 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. (for Time Log add-on) Note: means your Orangescrum access URL. Ex. (if you are using localhost) (if you are using IP) domain) (if you are using any valid Do the same for other add-ons. Ex. (for Invoice add-on) (for Task Status Group addon) (for GanttChart add-on) (for Recurring Task add-on) 5 Designed and Powered by

6 (for API add-on) (for Chat add-on) add-on) (for Project Template addon) (for Client Management Note: you can find notification.js, node-js-installation-linux.pdf, node-jsinstallation-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. 6 Designed and Powered by

7 How can I create Recurring Task? Hover on + or click on +New and again click on Create New Task/ Task to create a new task. Move on to Create Task Page. Fill the Task title, task description and other (optional) fields. Select the option Repeat. You ll see one pop-up window Task Recurrence as shown in picture below; Select Recurring Pattern/type (for ex. daily, weekly, monthly and yearly); and Range of Recurrence: Start date, end date, occurrences and click on Save. Remember the Recurring Task will be created on days before the end date of Recurring Task (End by) or the days after, every n days of a month whichever will come first but the due date of that recurring task will be the Recurring End date (end by) or the days after, every n days of that month. 7 Designed and Powered by

8 Recurring Pattern: You have four repeat types: Daily, Weekly, Monthly, and Yearly. Daily Recurring: If you select daily, then task will automatically create on every weekdays (all days except Saturday & Sunday) and after one/two or any custom days as you select. For example; select Recurring Pattern Daily & under that enter Every 1 day recurring and your task s recurring start date is March 1 and Ends by is March 8. Then the recurring tasks will be created on March 2 with due date March 3 & same task will be created till March 7 with due date March 8. If you select No End date, then recurring task will be created on March 2 to all days with the due date will be the next date. If you select the occurrences to 2 or 3, then the recurring task will be created on March 2, March 3 & March 4 with due dates March 3, March 4 & March 5 respectively. If you select Every Weekday instead of every 1/2/3 days, then the recurring tasks will be created on every weekday (except Saturday & Sunday) till the end date. If you select 0 days, then the tasks will be created with no recurring. Weekly Recurring: Here you can select after how many weeks of the recurring start date & on which day of the week, the recurring tasks will be created. 8 Designed and Powered by

9 For example: If you select Every 1 week on Monday & Friday of a task with recurring start date March 1 and Ends date is March 15, then the recurring tasks will be created on March 3, March 6, March 10 & March 13. If you select no end date, then it will create the task on every Monday & Friday. If you select occurrences then it will stop creating repeat tasks after the occurrences complete. If you select Every 0 week, Orangescrum will select this week by default. On that week the repeat tasks will be created on Monday & Friday. Monthly Recurring: Selecting this option, you can create Recurring Tasks on which date of a month or which day of a month. 9 Designed and Powered by

10 For example; you have a task with recurring start date March 2 and end date March 28, and you select the Day 25 of every month to create the Recurring task. Then on March 24, the recurring task will be created with due date March Designed and Powered by

11 With no end date, it will create the task automatically on 24 th of every month with due date 25 th of every month. If you select occurrences 3, then on March 24, April 24 & May 24; it will create tasks and after that it will create no repeat tasks. Yearly Recurring: Here you can select after which year of creating a task, you want to create the recurring task on which date or day of a month. 11 Designed and Powered by

12 12 Designed and Powered by

13 For example, if you want to create a task automatically on March 28, 2018, then create a task with recurring start date March 2 (any date before March 28), and end date April 25 or you can select no end date or no occurrences 13 Designed and Powered by

14 as well. Then you can select the Month March & day 28. Orangescrum will automatically create the task on March 27 with due date March 28, Start Date: Select the start date when you want to start the task repeating. Occurrences: Enter the occurrences after which the repetition will end. End Date: Select the end date after which the recurring will stop. 14 Designed and Powered by

15 Click on Post to finish & create the recurring task. You can see the Recurring Task in Task List page as shows in the below image. 15 Designed and Powered by