An Issue has an HTML based rich text formatted description that can contain images, tables, and even mentions of users and objects. An Issue also has the classic attributes (e.g. Status, Priority, Assignee, Reporter) and the relationships (e.g. Blocks, Related To, Duplicates) commonly used by issue tracking systems such as Atlassian JIRA.
A new pre-installed "Standard Extension Issues" package allows users to create new models of type "Issues" which contains the Issue object type (just like Glossary contains Terms). Manage >Metamodel allows one to extend the Article object type with custom attributes or links to other custom objects. Issues benefit from the same capabilities as any other custom objects including search (Metadata Query Language (MQL)), security, as well as the ability to have comments, and even operate under workflow.
Create an Issues Custom Model
To create issues you must create a custom model for them to be contained in. You may create any number of these models to contain various collections of articles. You create a custom model just as you would a glossary by creating a model in a folder in the repository and including it in configurations.
Steps
-
Sign in as a user with at least the Metadata Management capability object role assignment on the Configuration you are in.
-
Go to MANAGE > Configuration in the banner.
-
Click the Add (plus sign) under Manage Configuration and select the model type you wish to instantiate. In this case it is Issues.
-
Enter a Name and Description for the instantiated custom issues model and click OK.
There is a Workflow tab available for custom models. Please refer to the specific examples for glossaries (a type of custom model) for full details on how to set up and use workflow with a custom model.
Example
Sign is as Administrator and go to MANAGE > Configuration. Click the click Add under Manage Configuration and select Issues.
Give it the name "Finance Issue Tracking" and click OK.
Create and Edit Issues
Once you have created an Issues custom model, you may add individual issues to it.
Steps
-
Sign in as a user with at least the Metadata Management capability object role assignment on the Issues model in which you wish to edit issues.
-
Navigate to the Issues model.
-
Click the Add.
-
Enter a Name and Description for the Issue and click OK.
-
Now you may edit the rest of the fields the issue.
There may be workflow enabled available for custom models. Please refer to the specific examples for glossaries (a type of custom model) for full details on how to set up and use workflow with a custom model.
Example
Sign in as Administrator and navigate to the object page for the Finance Issue Tracking model.
Click +CREATE next to Issues.
Here is the text for the fields:
-
NAME: "Definition and Certification of Finance Terminology
-
DESCRIPTION:
Proper semantic linking and thus name and definition inference to
physical data elements (tables and columns)"
Otherwise, enter the values as shown below and click OK.
Relate Issues
There are a number of relationships which may be defined on an issue. These include:
-
Applies to
-
Blocks
-
Defines
-
Duplicates
-
Has Issue
-
Is Blocked By
-
Is Defined By
-
Is Duplicated By
-
Is Related To
-
Relates To
Steps
-
Sign in as a user with at least the Metadata Management capability object role assignment on the Issues model in which you wish to relate issues.
-
Navigate to the Issues model.
-
Click the Add.
-
Enter a Name and Description for the Issue and click OK.
-
Now you may edit the rest of the fields the issue.
There may be workflow enabled available for custom models. Please refer to the specific examples for glossaries (a type of custom model) for full details on how to set up and use workflow with a custom model.
Example
Sign in as Administrator and navigate to the object page for the Finance Issue Tracking model.
Click the Definition and Certification of Finance Terminology issue.
Click +ADD next to Relationships.
Enter "Finance" in the search text and Glossary for the CATEGORY.
Pick the Finance glossary and click OK.
This issue now Applies to the Finance glossary.
Click the Finance glossary link.
And you can see that when you look at the glossary, it shows that there is an issue related to it.
Delete Issues
You may delete issues by hovering the mouse over the issue on the model object page and clicking the Delete (red X) icon.