You are viewing the old version of the documentation. See the latest version here: [CRMJS:CRM for Jira Server Home]

To start working with company or contact card you need to create attributes for these objects in CRM settings. Attribute properties and its types are listed below.

Attribute Types

Type of an attribute is one of the attribute properties. The set of other attribute properties depends on the attribute type.

Attribute TypeDescription
String (255 chars)For simple string type attributes such as "Phone", "E-mail", etc
E-mailType to store E-mail of a company
WebsiteType to store Website address of a company
dateDatepicker with calendar for date type attributes such as "Contact birthdate".
numberInteger number. For example, "Number of users".
checkboxSingle checkbox (yes\no). For example "Is platinum partner: Yes"
list of values

Used for selecting one value from cascading list. For example, "Company type" or "Branch". Possible values should be set in attribute property "Field values". For example: "1:Client;2:Rival;3:Partner;4:Agency"

PositionValues from Position dictionary. If there is no positions you can enter new value and save contact - new position will be added in the dictionary.
Contacts

List of contacts related to the company. Select fields to show in Company card. You can add/edit/remove contacts here.

Contact

This field is used for selecting main contact/contacts of the company. It is used for displaying main contact in the company dictionary or for searching company by contact. There can be several fields of Contact type in Company card with different contacts selected.

Company

This field is used for selecting company in contact card. Contact can be related to only one company at the moment. You can enter new value here - in that case a new company will be created in the company directory.

JQL

This table-field displays JIRA issues by JQL-filter with necessary attributes. The value must be specified as JQL-filter in attribute property "JQL condition"

(info) If you want to dispay JIRA issue where current company or contact is specified - you need to provide the following values in the filter:

  • for company field type CRM Company: 'Company' = CURRENT_NAME

  • for company field type CRM Company (Deprecated): 'Company' ~ CURRENT

  • for contact: 'reporter' = CURRENT

  • for other type field, for example, Database Information: 'name field' = CURRENT_NAME

Example of JQL condition: "project = SALE AND issuetype = SALE AND 'Company' = CURRENT_NAME"

(info) If you want to dispay JIRA issue where company is not specified - you need to provide the following values in the filter:

  • for company field type CRM Company: Company IS EMPTY or Company = "Not defined"
  • for company field type CRM Company (Deprecated): Company ~ "Not defined"
Parent company

This field is used for selecting parent company in company card. Parent company can have many child companies but only one parent can be set for company. Parent-child relations may be ussed for set issue security, see more

CRM Security Levels

Child companiesThis field is used for selecting child companies in company card. You can enter new value here - in that case a new company will be created in the company directory.
DirectoryField to store some value from specified CRM custom directory  (only one value). It's possible to add new values to the dictionaries through the fields of this type. The dictionary should be specified in the attribute property "Dictionary".
Multi Directory ValuesField to store several values from specified CRM custom dictionary . The dictionary should be specified in the attribute property "Dictionary".
Table listPlaces a table into Company / Contact card from Table Lists sub-menu.
Related Projects

You could link some companies and contacts with any JIRA project. See more: Related Projects

JIRA userType to store one or more JIRA users, for example account manager of a company. It's possible to give additional CRM permisions for JIRA users, stored in fields of this type. See more there: Setting up Access to Objects
JIRA groupType to store one or more JIRA groups.It's possible to give additional CRM permisions for JIRA users, stored in fields of this type. See more there: Setting up Access to Objects
TransactionsList of transactions related to the company. You can select fields to show in Company card and in Issue transaction view.
CounterField to set the order number to Company records. There is no possibility to assign number manually, it is made automatically. For every new record Counter field type adds 1 to previous created even if it was deleted.
TextareaFor multiple string type attributes. Maximum length is 400 symbols (including space and enter).
Status dateField to store date of Transaction's status changing.
CreatorField to store record creator name (fills in automatically, not editable).
Creation dateField to store record creation date (fills in automatically, not editable).
UpdatorField to store record updator name (fills in and updates automatically).
Updated dateField to store record update date (fills in and updates automatically).
E-mail is validCheckbox to show if contact's e-mail passed through validation during Direct Mail process.
No subscribe meCheckbox to show if contact had unsubscribed from Direct Mail. 
EpicField to store Epic name in Transactions if transaction is in issue which is part of an Epic.

Attribute Properties

Properties common to all types

PropertyType of property valueDescription
Field titleStringThis value will be displayed in a card or dictionary.
Field typeCascading Select list of types

There are fixed set of attribute types with unique features. See full list and description in the table above.

Show in gridCheckboxIf checked this property will be shown in the directory as a column.
Is titleCheckbox

(warning) This is the most important property. It must be checked only in one attribute - usually company or contact name. It shows that this is a key attribute and is used in dictionaries for searching company/contacts. If this property is checked in another attribute it will be unchecked in current attribute.

Is requiredCheckboxIf checked the system will require users to fill in the attribute before saving contact/company.

Show in a CRM name field

CheckboxIf checked the attribute will be shown in brackets in the field marked as "is title" in CRM directories.

Show in CRM custom fields

Checkbox Company/Contact issue fields format. If checked the attribute will be shown in brackets with contact (company) name in issue's CRM custom field.
Is read onlyCheckboxIf checked this attribute will not be available for editing.

From creation

CheckboxThis property is pared to "read only". If checked the attribute will be not editable from the moment of it's creation. Unchecked allows to fill in the attribute while creating new record in CRM directory.

Restrict duplicates

CheckboxIf checked the system will examine if the same value for this attribute already exists in CRM directory and decline creation (import) of duplicate.
To search byCheckboxIf checked the system will use this attribute for searching in addition to company name. It is useful if you have two fields for name in English and in Russian. If you check this property in "Russian name" attribute you can search company by either Russian or English name.
FieldsStringSee full list and description in the table below.
TabCascading Select list of tabsThe tab on which to put the attribute. If the tab list is empty - just create tabs in tab table.
WidthIntegerThe width of the attribute in pixels. Important for fields like "address", "full name", etc.
By defaultCheckboxIs used for Checkbox attribute type. If unchecked, new records will be created with unchecked checkbox attribute. If checked - checkbox attribute will be checked by default for new records. Notice that for existing records checkbox attribute is created unchecked.
Set from companycheckboxIs used in Transactions


Special properties for some attributes types

PropertyType of attributeType of property valueDescription
Directory

Directory

Multi Directory Values

Cascading Select list of custom directoriesSpecify a custom directory in this field, to choose values from.
JQL conditionJQLJQL-filter

The value must be specified as JQL-filter in attribute property "JQL condition"

(info) If you want to dispay JIRA issue where current company or contact is specified - you need to provide the following values in the filter:

  • for company: 'Company' ~ CURRENT

  • for contact: 'reporter' = CURRENT

  • for other type field, for example, Database Information: 'name field' = CURRENT_NAME

Example of JQL condition: "project = SALE AND issuetype = SALE AND 'Company' ~ CURRENT".

Notice that JQL can be not larger than 250 symbols.

FieldsJQLString

This property allows to set columns which would be shown in Company table attributes like issues (JQL), transactions, contacts.


1) For JQL attribute type

If not set in the "JQL" field there will be only 3 standard columns (issuekey, summary and status). If you need additional issue fields displayed in the "JQL" field you must enter JIRA customfields ID's (without spaces).

Example: "issuekey,customfield_14440,summary,customfield_10163,status".

All available fields:

  • customfield_ID
  • issuekey
  • summary
  • created
  • updated
  • securityLevelId
  • dueDate
  • environment
  • description
  • issueType
  • resolution
  • resolutiondate
  • affectedVersions
  • fixVersions
  • components
  • project
  • status
  • prioritet
  • assignee
  • reporter
  • labels
  • subtasks
  • timeoriginalestimate
  • timeestimate
  • timespent

2) For Contacts attribute type. You may set contacts attributes names (without spaces between field names and commas).

3) For Transactions attribute type. You may set transactions attributes names (without spaces between field names and commas).

Field valueslist of valuesString Possible values of a list should be set in this property "Field values". For example: "1:Client;2:Rival;3:Partner;4:Agency"
Set from companyDirectoryCheckboxIs used in Transactions Directory attribute. When checked directory value is taken automatically from the same "Directory" attribute of Company.



  • No labels