Worklog Sheet

Plug-in Information Functional Description Screenshots Atlassian Plugin Exchange Download Trial Order Form License Technical Information Installation Configuration Roadmap Development History VAT on Purchases

The installation of Worklog Sheet does not overwrite any files in the JIRA deployment directory. However it is recommended that the data in your JIRA instance is backed up with the JIRA data backup tool in the JIRA administration pages prior to installing Worklog Sheet.

Worklog Sheet comes in a Zip bundle that contains release packages for supported JIRA versions and release types (full, upgrade or trial). Extract the appropriate release type and version from the Zip bundle prior to installing or upgrading.

Worklog Sheet is a 'Version 1' JIRA plug-in. To install Worklog Sheet to your JIRA instance, follow these steps:

1. Extract the release package to JIRA deployment directory (e.g. APP_SERVER_HOME/webapps/atlassian-jira-4.0)
2. Restart your JIRA instance

After your JIRA instance has started up, execute the following steps in order to be able to use Worklog Sheet:

1. Go to the JIRA administration page and select "Worklog Sheet" under section "Options"
2. (Required) From "Worklog Sheet Plug-in Settings" page, select the groups you wish to have access to Worklog Sheet plug-in from section "User Groups"
3. (Required) From section "Issue Filter" select the GLOBAL issue filter that is used to filter the issues that are editable in Worklog Sheet. More information about issue filter creation is available in the configuration intructions. Warning: skipping this step may lead to severe performance issues in your JIRA instance!
4. (Optional) From section "General Settings/Localization" you can configure how work log entries are displayed in Worklog Sheet.

Upgrading

To upgrade Worklog Sheet, follow these steps:

1. Remove any cache files created by the application server running your JIRA instance
2. Remove the plug-in JAR file of the previous version
3. Extract the release package to JIRA deployment directory (e.g. APP_SERVER_HOME/webapps/atlassian-jira-4.0)
4. Restart your JIRA instance

The plug-in JAR file is located in the library directory of your JIRA installation (e.g. APP_SERVER_HOME/webapps/atlassian-jira-4.0/WEB-INF/lib). The plug-in JAR file itself is named like worklog-sheet-VER.SI.ON.jar.

Migrating to a New JIRA Instance

Instructions for Please note that before executing either of these migration instructions, you should make sure that

1. your existing Worklog Sheet installation is compatible with the new JIRA instance and
2. if you are updating your JIRA license, the new license is compatible with the existing Worklog Sheet installation.

If you find that either of the above requirements are not fulfilled, you should upgrade your Worklog Sheet installation. To migrate Worklog Sheet to different types of new JIRA instances while preserving the existing settings, you can either:

• (JIRA EAR-WAR) extract the Worklog Sheet release package* to the edit-webapp folder of the new JIRA instance's build folder and overwrite the default properties file with the Worklog Sheet properties file from the old JIRA instance's classes folder (e.g. OLD_APP_SERVER_HOME/webapps/atlassian-jira-4.0/WEB-INF/classes/WorklogSheetPlugin.properties) before building the new JIRA instance, or
• (JIRA Standalone or JIRA EAR-WAR) install Worklog Sheet anew* to the new JIRA instance and overwrite the default properties file in the new JIRA instance's classes folder (e.g. NEW_APP_SERVER_HOME/webapps/atlassian-jira-4.2/WEB-INF/classes/WorklogSheetPlugin.properties) with the Worklog Sheet properties file from the old JIRA instance's classes folder. It is recommended that you back up the properties file to a safe place before migrating.

*If you have an existing Worklog Sheet license that is compatible with the new JIRA instance and have lost the original release package, you can request a new copy by contacting support.

Uninstalling

To uninstall Worklog Sheet, follow these steps:

1. Remove the following files and directories:



Item	Description
APP_SERVER_HOME/webapps/atlassian-jira-4.0/secure/views/worklogsheet	A directory that contains Worklog Sheet JSP files.
APP_SERVER_HOME/webapps/atlassian-jira-4.0/WEB-INF/classes/WorklogSheetPlugin.properties	Worklog Sheet settings file.
APP_SERVER_HOME/webapps/atlassian-jira-4.0/WEB-INF/lib/worklog-sheet-x.x.x.jar	Worklog Sheet plug-in JAR file.



2. Restart your JIRA instance