FishEye 2.1 : FishEye Web Items
This page last changed on Aug 05, 2009 by edawson.
Web UI plugin modules allow you to add links, tabs and sections of links to the Fisheye user interface. By adding a link to a servlet plugin, you can add your own pages to the UI. Your pages will need to ask FishEye to decorate them. On this page: Web Section DefinitionYou may choose to create your own web sections or add to FishEye's predefined ones. Here is a sample atlassian-plugin.xml fragment for a web section: <web-section key="testsection" name="example.section" location="system.fisheye.file"> <label key="System Fisheye File Section"/> </web-section> <web-item key="eg7" section="system.fisheye.file/example.section"> <label key="System Fisheye File/Example Section"/> </web-item> The above example will creates a new section in system.fisheye.file. You can then add a web item in the section. The location of the web item in the second code block is the same as the first, but it uses the web item example.section which is defined in the first code block. Web Items Listing and Reference
Web Item ConditionsConditions control whether a given web item will be displayed. com.atlassian.fisheye.plugin.web.conditions.HasCrucible com.atlassian.fisheye.plugin.web.conditions.HasFishEye com.atlassian.fisheye.plugin.web.conditions.HasProjectPermission com.atlassian.fisheye.plugin.web.conditions.HasReviewPermission com.atlassian.fisheye.plugin.web.conditions.IsFile com.atlassian.fisheye.plugin.web.conditions.IsReviewInState com.atlassian.fisheye.plugin.web.conditions.IsRootOrDirectory com.atlassian.fisheye.plugin.web.conditions.IsSystemAdministrator com.atlassian.fisheye.plugin.web.conditions.UserCanAccessCrucible com.atlassian.fisheye.plugin.web.conditions.UserLoggedInCondition Condition ParametersThe following conditions take parameters:
The usage and conditions that these parameters apply to are tabled below.
Applying these values will cause the action to be enacted on the currently logged-in user. Example of Condition Parameters in Use <condition class="com.atlassian.fisheye.plugin.web.conditions.HasReviewPermission"> <param name="actionName" value="action:approveReview"/> </condition> Example of a Web Item Condition in Use<web-item key="hello-file2" section="system.crucible.review.fileitem"> <link>#set($x = 'test')/plugins/servlet/${x}-servlet?name=${helper.global.user.displayName}</link> <label key="Id: {0}"> <param name="param0">${helper.review.permaId.id}</param> </label> <condition class="com.atlassian.fisheye.plugin.web.conditions.IsReviewInState"> <param name="stateName" value="Draft"/> </condition> </web-item> Visual Locations of FishEye Web ItemsThis item relates to links in the left navigation bar, in the FishEye admin menu. Screenshot: FishEye's system.admin/repositories Web Item Cannot resolve external resource into attachment. Screenshot: FishEye's system.admin/global Web Item Cannot resolve external resource into attachment. Screenshot: FishEye's system.admin/system Web Item Cannot resolve external resource into attachment. This item relates to actions performed on a changeset, displayed next to the review creation link in the FishEye UI. Screenshot: FishEye's system.fisheye.changeset Web Item This item relates to links in the directory tree shown in the left hand navigation bar, under the FishEye Source Tab. Screenshot: FishEye's system.fisheye.directory Web Item This item relates to per-file links on the FishEye Browse Tab. Screenshot: FishEye's system.fisheye.file Web Item This item relates to actions which can be performed on a repository on the FishEye main page. Screenshot: FishEye's system.fisheye.repo Web Item This item relates to actions performed for a revision in the FishEye UI. Screenshot: FishEye's system.fisheye.revision Web Item Screenshot: FishEye's system.fisheye.revision Web Item, additional location This item relates to links at the bottom of the FishEye main page. Screenshot: FishEye's system.main/fisheye Web Item
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
![]() |
Document generated by Confluence on Nov 11, 2009 21:21 |