...
Data source configuration
A REST API data source will allow allows you to fetch data from an external source of data (your USM system) and populate the custom field options with this data. You will need this This step is crucial for the further configuration following setup of the USM Object Select List custom field.
Access the global administration page for USM Connector for Jira: Object Select global administration page
Click on the 'Create a data source'button
Enter Provide a name and input all needed the necessary connection parameters (, including authorization and service details, service) for this new data source. Click onĀ Create.
Finally, click on the 'Create' button to complete the data source configuration."
After a successful creating successfully creating a data source, you will find a list appears displayed on this page including , showing all the data sources currently available in your Jira instance.
...
USM Object Select List custom field configuration
This application offers provides a fully integrated Jira Forge custom field , using that utilizes data sources created in the preceding step above.
It provides a select list (retrieving data from configured external data sources) that can be used in your projects. Due Please note that, due to Atlassian limitation it can only be used in 's constraints, it is compatible only with Jira company-managed projects.
First Initial steps:
Once After configuring the data source is configured, please proceed to create a new custom field in the Jira System settings.
Select > Issues
Under FIELDS, selectĀ Custom fields and click on the Create custom field button
Select the type of field ā USM Object Select List
Add the details for your field and selectĀ Create
Associate the new custom field with one or multiple screens byĀ ticking the corresponding boxboxes
Next Following steps:
Once the custom field is created, to make the custom field work as expected it needs to be configured firstit must be configured to function as intended.
Select > Issues
Under FIELDS, selectĀ Custom fields and find the custom field you have just created
Under the custom fieldās settings options select Contexts and default value and click on the Edit custom field config button.
In Within the custom field configuration, you first configure will set up a query which will fetch to retrieve relevant results (choosing selecting the fitting appropriate data source and entering specifying your specific unique condition), and then subsequently apply a template on to each row of the fetched retrieved result set.
Fetch data from API
To successfully fetch retrieve data from the API, please select a data source you would like to connect to. Without it you will not be able to save this configurationyou must first select the desired data source for connection; without this step, saving the configuration will not be possible.
Then set up the condition parameter. The condition parameter tells the system what data (in what format) should be received.
| Info |
|---|
In Within the condition parametr parameter smart values can be used. Smart values allow you to easily access issue data within Jira. For now, only the {{project.key}} that returns the issue project's key is supported in terms of retrieving issue data. Another very useful smart value can be {{inputValue}} that corresponds to the value that user types in to the select for the purpose of retrieving (filtering) select options. |
...
| Code Block |
|---|
{
"types":[
{
"type":"System",
"condition": {
"buildCondition":"manual",
"parts":[
{
"field":"name",
"value":"{{inputValue}}",
"operator":"startswith"
}
]},
"sortedBy":[
"datchg descending"
],
"fields":[
{
"name":"name"
},
{
"name":"status"
},
{
"name":"systemname"
},
{
"name":"systype"
},
{
"name":"validfrom"
},
{
"name":"validto"
},
{
"name":"datchg"
}
],
"seekRead":{
"pageRequest":"first",
"pageSize":"1000"
}
}
]
} |
Look and feel
As simple as that you can easily Here's how straightforward it is: You have the option to choose between the select list custom field beingas either Single Choice or Multiple Choice, allowing user to pick only one, respective several options users to make a single selection or multiple selections (values) at oncesimultaneously.
Then you finally get to applying Next, you'll proceed to apply a template on to each row of the fetched retrieved result set. It is a simple templating langue like that gets This template language is quite straightforward; it extracts values (fields) from the result set and finds for it matches them with the corresponding match placeholders in the template. So This makes it gets super incredibly easy to concatenate combine your fields together in the format of your choicepreference.
The Label template defines determines how you will see the options appear in the select list. , while the Value template defines the format and structure of the values that will be saved on in the background ā should uniquely identify , ensuring a unique identification of the given object.
It follows these two basic principles:
...
Example result:
DemoSystem
Optimizing Performance
For To ensure optimal performance purposes, it is recommended to get maximally 's advisable to retrieve a maximum of the first 1,000 rows of from a result set with and using the combination of the {{inputValue}} smart value and the 'startswith' operator startswith.
In this casescenario, choose select a system field (in the condition parameter) which will be used to query the data ā generally it is the ānameā type of field that is usually very well known among users in the system
...
to serve as the basis for querying data. Typically, the 'name' field type is usually widely recognized and used by system users.
| Info |
|---|
Don't forget to include this field in the label template, so that users actually can see the name they type as a part of the select options. |
A non-configurable cache for retrieved options exists. Identical queries will fetch the retrieved items values directly in the cache.
Configuration
...
complete
After saving your configuration, you can start to use using your new newly created and configured custom field. Now you should be able to see You should now observe the custom field working functioning as expected. To see any results (Keep in mind that to retrieve any options) , you'll need to type input at least 3 characters.
...
Troubleshooting
Ensure It is essential to confirm that the USM system is both active and availableaccessible. Currently, there is no way to find out if the connection is set properly method to pre-check the connection's proper configuration in advance.
Feedback and Support
...