This documentation is for Insight for Server/Data Center only.

Summary

Object type attributes enable important data to be added to objects. The attributes are type specific and all objects of that particular type can be defined by using the type attributes. Setting up type attributes requires Schema Manager's permission.

In this article

Attribute types are used to determine the attribute field's behavior. There are a few configuration items to consider for each attribute.

Label

Each Object must have a label and is the attribute that representing the object in Insight. You are allowed to change the label to any TEXT attribute. The default label is "Name" but can be changed from a system perspective in the Insight global app configuration in JIRA Administration add-on section.

Description

You can give the attribute a description to help your users to know what value to add in the attribute field.

Types of attributes

You can select the attribute type, this setting determines how the attribute value should be managed (and if its allowed).


Attribute TypeType ValueAdditional ValueDescription
DefaultTextNoneData type with text representation, often used when showing normal text. Maximum 450 characters.
DefaultBooleanNoneData type with only two possible values: true or false.
DefaultIntegerNoneCommonly known as a "whole number", is a number that can be written without a fractional component. For example, 21, 4, and −2048 are integers.

This Attributes supports the Long Integer and will allow numbers that range from -2,147,483,648 to +2,147,483,647

DefaultFloatNoneData type representing numbers with decimals.
DefaultDateNoneData type representing a Date field.
DefaultDateTimeNoneData type representing a Date and Time field.
DefaultURLNoneData type representing an URL field. May be used for URL Ping service that pings the address every 5 minutes from the server side. Watch object to get email notifications on URL Ping Up/Down.
DefaultEmailNoneData type representing an email field.
DefaultTextareaNoneData type with text representation, often used when showing large text. Use Insight rich editor to customize the content. Unlimited characters in comparison to the Text attribute.
DefaultSelectNoneData type to represent text values, predefined as options.
DefaultIP AddressNoneData type to represent IP Addresses (IPv4)
ObjectInsight objectReference TypeThis type enables a reference to another Insight object.
UserJira groupShow on ProfileThis type makes it possible to select a user from the selected Jira group and connect object/s with users.
ConfluenceConfluence instanceConfluence pageThis type enables a link to a Confluence page.
GroupNoneShow on ProfileThis type makes it possible to select a Jira group and connect object(s) with user(s) in specified groups.
VersionJira ProjectNoneThis type makes it possible to reference a Jira Version from a specific Jira Project to your object(s).
ProjectNoneNoneThis type makes it possible to reference a Jira Project to your object(s).
StatusAllowed StatusesNoneThis type is used to set a Status of an object. Define the statuses that should be allowed, and left empty means all statuses allowed.

(warning) In order for the Confluence attribute type to work, you must have an application link setup (Trusted Connection) between Jira and Confluence. Insight caches pages for 30 minutes, so any changes or page names will not be shown in Insight after 30 minutes. Your Confluence version needs to be 5.5 or above.

Additional configuration

Choose Configure to set additional configuration. Depending on the attribute type, you have different configuration options as shown below. "Location" is a Reference object type while "Price" is an Integer type.

 

General
SuffixFor default type "Integer" and "Float" you can set a suffix for the attribute. Example is "$" for an attribute "Salary".
HiddenHide the attribute from users in the "insight-users" role.
Include childrenInclude objects from a child object type(s).
Unique

Validate attribute values to be unique within the object type.

Show SumFor default type "Integer" and "Float" you can choose to add the values and display the sum of the attribute values
Indexed

This is a checkbox and you can use this to determine if you want to index this attribute or not.

The Indexed feature on every attribute essentially helps you to retrieve your search results faster when you do a basic search or an advanced search using IQL anywhere (e.g, post functions, imports, custom fields etc). So the recommended practice is that for all IQL queries used at these multiple places, you should index your attributes.

If your attribute is indexed, Insight will not retrieve results from the database every time but instead retrieve them from an index/cache which yields results quicker. However, this comes at the cost of a higher memory consumption.

For non-indexed attributes, memory consumption will be lower.

If you index an attribute, a small icon precedes the Name of the attribute as shown below. This icon will not be visible when you uncheck the Indexed checkbox.

Additionally, for the label attribute, the indexed icon will appear adjacent to the icon for the label as shown below.

By default, Insight will index all attributes on an object type, but the "Textarea" attribute is an exception to this rule.

The Key, Label, Created, and Updated attributes will always be indexed, as will any attributes of the type Reference.

Cardinality

You can specify a minimum and maximum of number of attributes values that can be associated to the attribute. This is common when you need to set an attribute multiple choices or required / mandatory.

For attributes of type "Default" you can only set maximum cardinality to 1, except "URL" and "Email" where you may space separate.

Validation

You may validate attributes of default type "Text", "Email" & "URL" with regular expressions. This can be handy if you want to validate specific information, like an IP address, a domain name, a phone number, or anything else that may require validation.

Options

You may add multiple Options to a "Select" Type Attribute by adding them here.

Filter objects

For attribute of type "Object" you may filter objects to be selected by IQL. By using this filter it is possible to create dependencies to other fields when creating/editing objects. 

The following examples shows how to configure an object reference attribute on the object type Employee to reference a Laptop. If a value is entered in the Manufacturer textbox only Laptops with the corresponding Vendor will be chosable. It is possible to combine multiple fields in the IQL to get multiple dependencies. Read more about the placeholders in order to figure out how to utilse them for your usecase. 

The employee has an outbound reference to Laptop. The employee also has an attribute called Computer Manufacturer

The IQL for attribute Laptop is configured with

Vendor = ${Computer Manufacturer}

The laptop has an attribute called Vendor