On this page:


Problem: your report in IBM Report Builder is missing one or more attributes.

These are most likely non-default Jira attributes. It's important to note that there are a few steps to take before these attributes are indexed in LQE, which will make them available to Report Builder.

Resolution

OSLC Attributes Not Available

Some of our OSLC Connect products allow the customization of the attributes that are included in the shapes. If you make a change in the attributes available you will need to make a meta-model refresh the same as the previous section.

Supported Jira Fields

If the value of a custom field doesn’t appear in your report, check the support level for this field in the OSLC Connect Issue Shapes settings.

In the example above:

  • The Development field is Not Supported, it’s expected to not be readable in your reports.

  • The Rank field has undetermined support, you need to manually test it. A value is available but we can’t tell if it’s readable.

Unfortunately, if the field you wanted to display in your reports is not supported, there is no configuration that will make it possible. Otherwise, if it’s supported or has undetermined support and you still have issues displaying it in your reports, you may proceed with the recommendations below.

Checking Jira fields' missing value

If OSLC Connect logs missing field values:

  1. Open Jira Settings > System > Logging and profiling

  2. In the Default Loggers section, add the following package with TRACE log level: com.sodius.oslc.app.jira.server.beans

  3. Run a reindex on the CM Resources Data Source in LQE.

  4. Open the atlassian-jira.log file.

In this log file, there are now two new logs you can look for:

  • '[FIELD_NAME]' custom field omitted as type is not supported: reminds that the field is not supported as indicated in the Issue Shape configuration page.

  • '[FIELD_NAME]' custom field omitted as value is not set for issue [ISSUE_ID]: indicates that the field has no value on a specific issue.

Finding the faulty node

To find out if LQE properly indexes your custom attributes, there are two tests you can do:

  1. Check if the issue shape contains your custom field,

  2. Check if LQE properly indexes the custom field.

Gathering information

Before you can run the tests, you need to retrieve these pieces of information:

Checking the Issue Shape

Once you have the Project ID, you can view the issue shape by reaching this URL in your browser: <JIRA_BASE_URL>/rest/oslc/1.0/cm/resourceShape/<PROJECT_ID>/issue

Initiate a search in the document (CTRL+F) and look for your custom field attribute ID: customfield_<ATTRIBUTE_ID>

You should find a block similar to this:

(tick) If you can find this block, this means that Jira is properly set up and will send this data through TRS.

(error) If you can’t find this block, there’s a missing configuration in Jira.

Solution: Please make sure that you set up the issue shape for the Issue Scheme of the project you are checking: Reporting on Jira Custom Attributes with Report Builder

Checking LQE index

Open LQE and go to the Query page. Leave the default configuration (Partition: Artifact; Scope: None), copy and paste the following query in the text field:

PREFIX process: <http://jazz.net/ns/process#>
PREFIX ns_validity_: <http://jazz.net/ns/validity#>
PREFIX owl: <http://www.w3.org/2002/07/owl#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
PREFIX oslc_config: <http://open-services.net/ns/config#>
PREFIX oslc: <http://open-services.net/ns/core#>
PREFIX ns_cm_x_: <http://atlassian.com/ns/cm-x#>
PREFIX rtc_merged: <http://jazz.net/ns/lqe/merge/gensym/cm/>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
PREFIX merge: <http://jazz.net/ns/lqe/merge/>
PREFIX dcterms: <http://purl.org/dc/terms/>

SELECT DISTINCT
  ?issueURI
  ?issueShortId
  ?issueCustomField
WHERE{
  ?issueURI process:projectArea ?projectAreaURI.
  FILTER(?projectAreaURI=<[PROJECT_AREA_URI]>)
  ?issueURI oslc:instanceShape ?issueURI_instanceShape.
  ?issueURI_instanceShape merge:mergeShape rtc_merged:Jira%20Issue.
  OPTIONAL {
    ?issueURI oslc:shortId ?issueShortId.
  }
  OPTIONAL {
    ?issueURI ns_cm_x_:customfield_[CUSTOM_FIELD_ID] ?issueCustomField.
  }
}
CODE

Replace the following tags with the appropriate values you retrieved in the first step:

  • [PROJECT_AREA_URI]: Project URI

  • [ATTRIBUTE_ID]: Attribute ID

You can now run the query, the result should appear:

The issueCustomField column has a value: LQE is properly indexing the custom attribute.

(tick) If you can see that an issue row has a value for the issueCustomField column, this means that LQE is indexing the custom attribute.

If you still can’t see this attribute in Report Builder, make sure you do a Metamodel Refresh for LQE in Report Builder Datasources.

(error) If the issueCustomField column is empty when it shouldn’t, this means that LQE is not indexing the custom attribute.

Solution: Please make sure that LQE ran the indexing on the Jira Data Source since you added the field to the Issue Shape.