Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

Remember that only Jira admins have permanent permission to create data sources. If you're a User, ensure you've received the necessary permissions from your Jira administrator before attempting to create a data source. For detailed instructions on how to set up permissions, please visit the Administration page.

To create a JSON Data Source in our app, follow these steps:

  1. Open Data Processor for Jira: Navigate to the app within your Jira Cloud instance.

    01_navigation_to_app_violet_no_arrows.jpg
  2. Go to ‘Data Sources’ ➡️ ‘JSON’: Select the ‘Data Sources’ section in the left-side menu, and then choose ‘JSON’ from the list.

    02_left_bar_violet_no_arrows.jpg

    or

    On the Home page of the main interface, click the 'JSON' icon.

    03_home_violet_no_arrows.jpg

  3. Create New Data Source: Click on 'Create your first Data Source' in the center of the screen if no Data Sources exist yet.

    04_create_first_data_source_violet_no_arrows.jpg

    If you've previously created Data Sources, select '+New Data Source' at the top right corner of the screen.

    05_add_new_data_source_button_violet_no_arrows.jpg
  4. Enter Main Information: Fill in the Name and optionally, a description for the Data Source. Click 'Next step'.

    06_main_information_violet_no_arrows.jpg
  5. Apply JQL Filter (Optional): Use JQL to filter your Jira data, if needed. Click 'Next step'.

    07_JQL_violet_no_arrows.jpg

    To learn more about JQL and get assistance with its syntax, please refer to this informative article. It offers valuable insights and guidelines to help you understand and effectively use JQL for your data queries.

  6. Select Tables and Fields: Choose the specific tables and fields you want to include in your Data Source.

    Available tables for export
    In the left section of the main interface, you'll find a list of all available tables for export. You can conveniently select the specific tables you need by clicking the 'Plus' button next to each table. This feature allows for a tailored and efficient export process, ensuring you export only the necessary data.

    08_available_tables_for_export_violet_no_arrows.jpg

    You can expand the tables to view the available fields and their formats, allowing for a clear understanding of the data structure before exporting.

    09_expand_tables_violet_no_arrows.jpg

    The complete list of tables and fields that are available for export can be seen here.

    Selected tables for export
    Clicking the 'Plus' button moves tables from the left section to the 'Selected tables for export' on the right. There, you'll select fields for export. Check the box next to a label to select all fields within it or expand the label to choose individual fields. The count of selected fields versus total available is displayed next to each label name.

    10_selected_to_export_violet_no_arrows.jpg

    To remove a table from those selected for export, simply click the ‘Trash bin’ button on the right. This will automatically move the table back to the 'Available tables for export' section, allowing you to adjust your selections as needed.

    11_trash_violet_no_arrows.jpg

    While selecting data for export, you may encounter ‘As Array of objects in the Issues table' and
    'As Nested object’ switches.

    12_switches_violet_no_arrows.jpg


    - As Array of objects in the Issues table:
    Nested JSON arrays of objects offer advanced data management by embedding objects within arrays for a structured, hierarchical format. This is particularly effective for representing complex relationships, enhancing both the efficiency and clarity in handling interconnected data. It's a preferred method in programming and data handling due to its organized approach to complex data structures.

    Here is an example of disabled and enabled As Array of objects in the Issues table for Worklogs:

    example_worklogs_as_array.png


- As Nested object:
Nested JSON objects are highly effective for complex data organization. They offer better structuring by allowing objects within objects, creating a hierarchical layout. This method enhances data organization and reduces redundancy, as repeated values can be stored in a single, overarching object, thus eliminating data duplication.

Here is an example of disabled and enabled As Nested object for Update Author:

example_update_author_as_nested.png
  1. Save Your Data Source: After selecting all the Tables and Fields you want to export, finalize your settings by clicking the ‘Save+’ button. This action will save the configurations you've made for your data export.

    15_save_plus_violet_no_arrows.jpg

You're now ready to export your Jira data into JSON format. For a comprehensive guide on how to proceed with this process, please refer to the detailed instructions available here.

To successfully activate the ‘Save+' button and create a Data Source, it's necessary to select at least one field in the 'Selected tables for export’ section.

Keep in mind that you can navigate between steps using the 'Previous step' and 'Next step' buttons, allowing for easy adjustments at any stage of the process.

To easily return to the Home page, simply click on the Data Processor Logo located at the top left corner. This provides a quick and straightforward way to navigate back to the main screen.



  • No labels