Configuring Link Appearance

When a Collaboration Link is created, the icon and title of the remote artifact are displayed for all link types and remote applications. Out of the box, and for most supported applications [1], the priority and status of the remote artifact are also displayed. This, as long as these properties are meaningful and part of the remote artifact definition. Requirements, for example, of IBM Engineering Requirements Management DOORS Family application do not define these properties by default; therefore, only the icon and title will be displayed for them until such properties are defined [2], [3], [4].

When available, the priority and status properties are displayed as text in default-colored Jira Lozenges. This default style can be customized to change the lozenge's color or to use an icon instead of it. Styling is based on the property value, this means that it's possible to have different colors or icons depending on the priority value (High, Medium, Low) or status value (New, Draft, Done) a remote artifact has.

Customizing the style of the Priority/Status of a remote artifact.

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Link Appearance option in the OSLC Connect section.
  3. Select the Priority or Status tab depending on which property value is to customize and click on the corresponding Add Priority or Add Status button.
  4. Fill out the form on the opened dialog according to the following field descriptions:
    Field Required Description Notes
    OSLC property value Yes A matching value (case insensitive) of the remote property. This is the value of the remote property that is under customization.
    Typical values for priority are High, Medium or Low whereas for status are New, Draft, Done.
    Label No An alias text to display instead of the remote property value. If the remote property value is not user-friendly, this setting can be used to set an improved label.
    Display with Yes Determines whether to style by color or icon. Choose according your preferences or needs.
    Color Yes The Lozenge color to use. This field will be visible only if Display with "Color" is selected.
    Icon URL Yes The icon URL to use. This field will be visible only if Display with "Icon" is selected.
    Any Internet-accessible image can be used by typing its corresponding URL.
    Jira default icons can also be used by typing its relative path on the server or clicking on the select image link and picking one from the opened dialog.
    Sample No Not an input field. On this space will be displayed a sample of how the property value will look like.
    Note No Free input text for notes.
  5. Click on the Save button.

If everything went ok, the chosen style will be saved and displayed in the corresponding tab. This style will be used then, the very next time a user access an issue page, in the Issue Links area.

Removing the style customization of the Priority/Status of a remote artifact.

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Link Appearance option in the OSLC Connect section.
  3. Select the Priority or Status tab depending on which property value is to delete.
  4. Locate the style you want to remove and click on the cross icon located on the last column of the table.
  5. Confirm your decision by clicking on the OK button in the confirmation dialog.

If everything went ok, the chosen customization will be removed from the system and it will no longer appear on the table. Regular users will see the property value with the default style again in the Issue Links area.

Note: if the intention is to prevent the display at all of the property value, uncheck the checkbox right below the Priority or Status tab. Be aware that this will apply for all Collaboration Link types and remote applications.

Updating the style customization of the Priority/Status of a remote artifact.

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Link Appearance option in the OSLC Connect section.
  3. Select the Priority or Status tab depending on which property value is to update.
  4. Locate the style you want to update and click on the pencil icon located on the last column of the table.
  5. Update the style information in the opened dialog (the OSLC property value is not editable).
  6. Click on the Save button to save these changes.

If everything went ok, the chosen customization will be updated and changes will be reflected in the list.

Note: if the OSLC property value is the field to change, remove the customization and create it over.