...
Your Sykora IT.
Table of Contents |
---|
Getting Started
To make it happen, simply install USM Connector for Jira: Object Selecton your Atlassian platform by following these simple steps:
Search for application USM Connector for Jira: Object Select in the Atlassian Marketplace.
Install USM Connector for Jira: Object Select into your Jira Software Cloud environment.
First steps after installation
Configure the USM Connector for Jira: Object Select App
Data source configuration
USM Object Select List custom field configuration
Configuration
Data source configuration
A REST API data source allows you to fetch data from an external source of data (your USM system) and populate the custom field options with this data. This step is crucial for the following setup of the USM Object Select List custom field.
...
After successfully creating a data source, you will find a list displayed on this page, showing all the data sources currently available in your Jira instance.
...
USM Object Select List custom field configuration
This application provides a fully integrated Jira Forge custom field that utilizes data sources created in the preceding step.
...
Within the custom field configuration, you will set up a query to retrieve relevant results (selecting the appropriate data source and specifying your unique condition), and subsequently apply a template to each row of the retrieved result set.
Fetch data from API
To successfully retrieve data from the API, you must first select the desired data source for connection; without this step, saving the configuration will not be possible.
...
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
Here's how straightforward it is: You have the option to choose between the select list custom field as either Single Choice or Multiple Choice, allowing users to make a single selection or multiple selections (values) simultaneously.
...
Example result:
DemoSystem
Optimizing Performance
To ensure optimal performance, it's advisable to retrieve a maximum of the first 1,000 rows from a result set and using the combination of the {{inputValue}} smart value and the 'startswith' operator.
In this scenario, select a system field (in the condition parameter) to serve as the basis for querying data. Typically, the 'name' field type is usually widely recognized and used by system users.
...
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 using your newly created and configured custom field. You should now observe the custom field functioning as expected. Keep in mind that to retrieve any options, you'll need to input at least 3 characters.
...
Security: Forge App IP Address Ranges
Atlassian has updated their published IP addresses and domains for Atlassian cloud products to include IP address ranges for outbound connection for Forge apps.
...
If you plan to use these IP address ranges, it's essential to monitor Atlassian's documentation for any changes. A JSON file containing this information is published at https://ip-ranges.atlassian.com/, which may be helpful for automation.
Data Residency 🛡️
USM Connector: Object Select, built on the Forge platform, offers you the advantage of data residency control. With the latest Forge capabilities integrated, you can securely store your USM connection data with confidence. This empowers you to align with your organization's data governance policies and ensures compliance with regional regulations. Your data remains safe and accessible, giving you peace of mind while using our app🔒.
Troubleshooting
It is essential to confirm that the USM system is both active and accessible. Currently, there is no method to pre-check the connection's proper configuration in advance.
Feedback and Support
Your invaluable feedback fuels the evolution of USM Connector for Jira: Object Select. Share your insights, and together, we'll cultivate a more refined and impactful user experience! 📊🌱
...