Custom Field Ambassadors User Guide
Welcome to the Custom Field Ambassadors user guide. This guide will help you understand, install, configure, and effectively use the Custom Field Ambassadors plugin available on the Atlassian Marketplace. Whether you’re an administrator managing custom fields or an Ambassador with delegated privileges, this guide provides comprehensive instructions to maximize the plugin’s capabilities.
Introduction
Custom Field Ambassadors is a powerful Atlassian plugin designed to streamline the management of custom fields within your Jira instance. It allows administrators to delegate custom field option management to specific users, designate these users as Ambassadors.
Installation
Installing the Custom Field Ambassadors plugin is a straightforward process. Follow the steps below to add it to your Atlassian Marketplace and integrate it into your Jira environment.
Access the Atlassian Marketplace:
Navigate to the Atlassian Marketplace.
Search for Custom Field Ambassadors:
Use the search bar to locate the Custom Field Ambassadors plugin.
Select the Plugin:
Click on the Custom Field Ambassadors listing from the search results to view its details.
Install the Plugin:
Click the Get it now or Free trial button.
Follow the on-screen instructions to install the plugin into your Jira instance.
Verify Installation:
After installation, navigate to your Jira administration settings to ensure the plugin is active.
Configuration
As easy as it sounds, Custom Field Ambassadors requires no further configuration .
For administrators
Nominating Ambassadors
Navigate to Ambassadors: Go to the Ambassadors tab within the plugin interface.
Open the Create Modal: Click the New Ambassadors button to open the Ambassadors creation modal.
Select Users: Use the User Picker to select one or multiple users to designate as Ambassadors.
Choose Custom Fields: Select the desired custom field from the Custom Field dropdown.
Select Contexts: Choose one or multiple contexts associated with the selected custom field.
Save Ambassadors: Click Save to create the Ambassadors assignment. A success flag will confirm the creation.
Assigning Contexts to Ambassadors
Select Ambassadors: In the Ambassadors tab, select the user(s) you want to designate as Ambassadors.
Assign Contexts: For each selected user, assign the relevant contexts where they will act as Ambassadors.
Confirm Assignments: Review the assignments and confirm to finalize the Ambassadors designation. Ambassadors will now have the authority to manage custom fields within their assigned contexts.
Filtering Ambassadors
Utilize the filter section located above the Ambassadors table to narrow down Ambassadors assignments. You can filter by specific users, custom fields, or contexts to view only the relevant assignments. To clear all applied filters and view all Ambassadors assignments, click Reset Filters.
Deleting Ambassadors
Single Deletion:
In the Ambassadors table, click the Delete button corresponding to the Ambassadors assignment you wish to remove.
Confirm deletion via the prompt.
Bulk Deletion:
Select multiple Ambassadors assignments using the checkboxes.
Click Delete Selected to remove all selected assignments at once.
Confirm the bulk deletion when prompted.
For Ambassadors
Managing Context Options
As an Ambassadors, you have the ability to manage the options within your assigned contexts. Here’s how to perform various actions:
Accessing Custom field Options:
Navigate to the Manage CF options tab.
Find the context you want to manage in your assignments list and click the Edit button to make updates.
After clicking Edit, a modal will appear displaying all the options for that context. From here, you can manage existing options or create new ones as needed.
Creating a New Option:
Click the “Click here to create option“ field within the context options section.
Enter the name for the new option. The option will be created automatically without the need to click the Save button.
Deleting an Option:
Find the option you want to remove.
Click the Delete button adjacent to the option.
Confirm the deletion when prompted to remove the option permanently.
Enabling/Disabling an Option:
Locate the option you wish to enable or disable.
Click the Enable or Disable button next to the option to toggle its status.
The option’s status will update accordingly, reflecting its availability.
Reordering Options:
Use the drag-and-drop handle next to each option to rearrange their order.
Release the option in the desired position to update the order.
The new order is saved automatically to maintain consistency.
Troubleshooting
If you encounter issues while using the Custom Field Ambassadors plugin, consider the following troubleshooting tips:
Plugin Not Visible: Ensure that the plugin is installed and enabled in your Jira instance. Verify that you have the necessary administrative permissions.
Unable to Create Ambassadors: Check if the selected custom fields and contexts are properly configured. Ensure that the users being designated as Ambassadors have the appropriate permissions.
Issues with Drag-and-Drop Reordering: Ensure that you are using a supported browser. Refresh the page and attempt the reordering process again.
Error Flags: Pay attention to error messages displayed via flags. Contact support if persistent errors occur.
Ambassadors Unable to Manage Options: Verify that the user has been correctly assigned as an Ambassadors for the specific context and that they have the necessary permissions to manage context options.
Support
For further assistance with the Custom Field Ambassadors plugin, please reach out through the following channels:
Support Portal: Visit our Support portal to submit tickets or browse existing support topics.
Contact Us: You can email us at support@jaanga.ca.
We are committed to ensuring that your experience with Custom Field Ambassadors is seamless and productive. Don’t hesitate to reach out for any support needs.
Thank you for choosing Custom Field Ambassadors! We hope this guide enhances your experience and helps you manage your custom fields effectively.