Currently, we support company-managed Jira projects. To integrate your Jira project with the Novorender viewer, two key custom adjustments are required: a component setup and a custom field configuration. Additionally, marker icons can be configured based on issue types.
1. Create a Component: Novorender-component
To ensure all issues created from the Novorender (NR) interface are correctly tagged, you need to set up a dedicated component in Jira:
Steps to create the component:
Log in as Jira Admin.
Navigate to Project settings in Jira.
Select Components from the left-hand menu.
Click Create component.
Enter the name: Novorender-component
Save the component.
Expected Behavior:
Any issue created from the NR interface will automatically be tagged with
Novorender-component
.Issues created manually in Jira will not have this component assigned by default.
2. Configure Custom Field: NOVORENDER_META
This custom field is essential for storing the marker position of issues created in the NR interface.
Steps to create the custom field:
Log in as a Jira admin.
Navigate to Project Settings -> Issues.
Under Fields -> Actions -> Edit fields
Select "Custom Fields".
Click "Create Custom Field", and choose the appropriate field type (e.g., Text Field).
Name the field as "NOVORENDER_META".
Save the field.
Associate the field with the relevant screens.
Once created, ensure that the field is correctly mapped and available for project use (See point 4).
Purpose:
The
NOVORENDER_META
field is available for your organization and can be reused in other projects within Novorender.It stores the marker position of issues created in the NR interface.
If needed, you can manually assign a position to an existing Jira issue using the Set Position button in Novorender.
3. Connect JIRA project inside Novorender project
Log into NR as project administrator.
Enable Jira integration from Adv. Settings -> Features -> Widgets -> JIRA -> Save
Navigate to JIRA in Integrations tab
Start filling out the mandatory fields marked with * :
βIn SPACE field type in name of your workspace
In PROJECT field choose your project name
In COMPONENT choose the created earlier component name
Novorender-component
4. Marker Icons Based on Issue Types
To enhance the visualization of issues in the Novorender viewer, marker icons can be customized based on the Jira issue types used in your project.
Customization Options:
Assign different icons to issue types such as Bug, Task, Story, or Epic.
Ensure consistency in visual representation for better issue tracking.
Example: