Page tree
Skip to end of metadata
Go to start of metadata

Plugin installation

The Ovyka Group Auto Assigner for Jira plugin is provided as a JAR file.

To install the plugin, go to JIRA Add-ons administration, and select the Manage Add-ons page. On the page, click the Upload add-on button, select the Ovyka Group Auto Assigner for Jira JAR, and click OK.

Prerequisites

User groups

The Ovyka Group Auto Assigner for Jira plugin requires that users groups are available : these groups will be needed in the mapping mail domains => user groups.

Each customer company should have its own group, and the list of email domains attached to this company will be mapped to their group.

Group names

To avoid confusing customer groups with other groups on your Crowd instance, it is recommended to prefix the user groups names with a specific string.

For example, for a group dedicated to the Apple customer, you could name the user group [C]Apple. This shows clearly that the group is a Customer group.

Group creation

User groups must be created in Crowd, not in Jira (but the add-on will work also with groups created in Jira). To add a custom group, go to your crowd instance, click on the Groups menu, then on the Add group link. A popup will open, allowing you to define the customer group. The screenshot below shows this popup.

Make sure to select he Ingenico External Customers directory.

Add users to customer group

Once the customer group is created, you must add users to the group. To do so, open the created user group (search it with the Search groups link, for example, then click the group name). After group creation, it will automatically open.

Then select the Direct Members tab. This screen will show no users for a newly created group (as shown in screenshot below).

To add users, click the Add users button. A popup will ope, allowing to search for users. Once you found some that you want to include in the group, check them and click the Add selected users button.

It's easier to search directly by email domain (e.g. "ovyka.com" will show all users with a mail containing this domain).

Synchronise JIRA with Crowd

Once the user groups have been created and filled with users, you can synchronise the Crowd directory in Jira, and the new group will be copied into JIRA. The screenshot below shows JIRA User management administration page. On the right of the Crowd Server directory, click the Synchronise link.

 

Custom Field

The Ovyka Group Auto Assigner for Jira plugin requires that a custom field exists, to store the user group of issues.

The custom field must be of Group Picker type. It is possible to add the custom field to the View screen, but not necessary for the plugin to work.

You must also make sure that the custom field is available in your projects. Below is a screenshot of the custom field configuration, where you must select the issue types and projects to which this custom field applies.

Example custom field

Type : Group Picker

Title: Customer Group

Description: Choose the customer group for visibility of this issue. Do not edit if autocompleted by Ovyka Group Auto Assigner for Jira

Permissions & Issue Security

Customers often have restricted permissions in the projects, often based on them being the ticket's Reporter. The Custom Field Group Picker's value (= customer group selected) must also be allowed to do the same things as the reporter on the ticket.

This implies a revision to the permission scheme, and issue security in case issues are not publicly visible to other customers.

Permission Scheme

Generally, the members of the customer group selected in the Custom Field Group Picker must have the same permissions as the Reporter

=> if such "reporter" permissions are applied in your target projects, make sure to update your permission scheme so the members of the same customer group have the same rights as the reporter.

This is the general use case, but you might want to use the feature just for a read only permission.

Issue Security

For Ovyka Group Auto Assigner for Jira to be able to grant access to customer's issues to all members of the customer group, an issue security scheme must be configured in Jira. This tells JIRA that users belonging to this issue security configuration are allowed to access issues monitored by the issue security.

Below is an example of an issue security configuration :

Two security levels are defined in this configuration :

  • Admin : allows administrators to access the issues monintored by this issue security
  • Clients: allows customers (ie. members of the selected user group - My User Group in the above example) to access issues monintored by this issue security

The issue security must then be applied to all projects to which customers should be granted access. This can be done in project adminstration, in the issue security administration page.

Below is an example project administration, with an issue security selected. On the top right, you can see the Actions button to use to change the issue security on a project (select Use a different scheme and select the correct issue security scheme).

 

Plugin configuration

When the Ovyka Group Auto Assigner for Jira is installed, new links appear in the Add-ons administration, under the label Ovyka Group Auto Assigner left menu, as shown below (you may have to reload the page if the plugin was just installed).

This menu gives you access to two administration pages :

  • Contexts : the contexts configuration, where custom fields are assigned to contexts (see below for more information on this)
  • Mappings : the administration of customer domain mapping.

Customer domain mapping

The customer domain mapping is the place where you can define to which group are assigned users with a same email domain. For example, you can configure that users with the apple.com email domain are assigned to the [C] Apple user group.

The list of configured mapping appear as shown in the screenshot below.

In the example above, all users with the ovyka.com email domain (for example frederic.esnault@ovyka.com) are automatically mapped to the Ovyka Team group.


This does NOT assign users with a matching domain to the configured group. It will only assign the group name to the custom field value in issues created by users with this email domain. See Context configuration for more on custom field configuration.

 

To add a customer mapping, click the Add a mapping button. This will open a popup window in which you can configure your mapping, as shown in screenshot below. When you begin typing in the Customer's group field, JIRA will show you groups it found containing the text you entered. Continue typing to restrict the number of matching groups, until you find the desired group.

Context configuration

Context configuration allows to define to which context (projects and issue types) a custom field is assigned. Configured contexts appear like in the screenshot below.

Context details

Title

The title of the context.

Projects

The projects to which the custom field is assigned to. Possible values are :

  • one project
  • multiple projects
  • all projects (to select all projects, do not enter any project in the context creation window).

Issue types

The issue types to which the custom field is assigned to. Possible values are :

  • one issue type
  • multiple issue types
  • all issue types (to select all issue types, do not enter any issue type in the context creation window).

Context creation

To create a context, click the Add a context button. This will open a popup window as shown in screenshot below.

The Issue Types, Projects and Custom Field fields work in the same way. Begin typing and JIRA will show you values matching the text you entered. Continue typing to refine the matching values, until you find the desired value.

If you leave the Issue Types field empty, your context will apply to all issue types. You can also select one or more issue types.

If you leave the Projects field empty, your context will apply to all projects. You can also select one or more projects.

  • No labels