Contents x
    Jira Walkthrough
    • 3 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Jira Walkthrough

    • 3 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    Currently supported:
    Rest API - Version 3
    Rest Agile API - Version 1

    This provides a general description of Jira and its capabilities.

    Reports

    Issues

    The issues report allows you to extract all issues from a given project/s

    1. (Optional) Select the projects you wish to extract issues from or leave empty to receive issues from all projects

    2. (Optional) If you want to get all issues with the exception of leaving out some projects, you can do so by selecting the projects under the "Excluded Projects " column

    Jira Walkthrough-projects

    1. (Optional) The issue report utilizes the Jira Query Language and therefor you may add additional filtering using "Advanced Search Query ". Do note that the conditions will be concatenated with an "AND" clause.

    Jira Walkthrough-jql

    1. Select a time period .

    The time period for the issues works with the JQL updatedDate see further instructions under the Time Period section

    Resolution

    The resolution report returns a list of all issue resolution values. This is a dimension.

    User

    The user report returns all the users in your Jira account.
    emailAddress
    A user's email column (emailAddress) will have an email address value for users whom set their profile privacy settings so that email address is public. Otherwise, this column will get a null value.

    Project

    The project report returns all the projects in your Jira account.

    Project Categories

    The project categories report returns all the project categories in your Jira account.

    Project Type

    The project type report returns all the project types in your Jira account.

    Project Rule

    The project rule report returns all the project rules in your Jira account.

    You can filter the which project rules to return with the project input or leave empty for all projects.
    Jira Walkthrough-projects 1

    Time period

    Relevant for the following reports: Issues.

    Jira Walkthrough-image12Select the type of time period of the report.

    It can be a custom date range (as described in the picture above) or a defined time period shown in the pop-up list (for example Yesterday, last week etc.)

    Instructions if selecting 'Date Range':

    1. Select the start date and end date.

    2. Leave the end date empty in order to pull data until the moment
    the river runs.
    3. After each run of the river, the start date will be updated automatically with the end date, and the end date will be updated with the empty value. This enables the next run to pull data from the end of the previous run.

    4. Select the time zone offset. It will be relevant only if the end date is empty in order to find the moment of the river’s run according to the time zone.

    5. Days back - use this input to tell Rivery to pull data from a given number of days back before the given start date.

    6. The Start Date won't be advanced if a River run is unsuccessful.
    If you don't want this default setting, click More Options and check the box to advance the start date even if the River run is unsuccessful (Not recommended).
    image.png

    Instructions if selecting any other value:

    Jira Walkthrough-image13

    Select the timezone offset in order to send the correct dates that consider that offset.

    Activity Logs

    The Activity Logs offer an inside perspective of the processes taking place in Jira river.

    Additional features in the Issues report

    Problem updating schema with all custom fields

    If you encounter scenarios where there are frequent alterations within your custom fields and you prefer to avoid the need for continual updates to the River's schema, The "Keep Raw Custom Fields" checkbox option comes into play.
    This option enables you to maintain the original custom fields in the form of a JSON string. Consequently, all your custom fields, regardless of whether they are older or newly introduced, will be encompassed within the River's mapping, specifically within the "raw_customfields" field.

    image.png

    Issues with a complex field

    If you experienced problem running the Issues report with one of the following errors:
    image.png

    image.png

    Please try checking this checkbox:
    image.png

    • By checking it, the field 'fields_description_content' will be a JSON string instead of a complex record field. This enables alternative datatypes in attribute fields (width/length), such as float/int types.
    • Afterwards, please clear the mapping and press automapping again to catch the new field's data type.

    image.png

    • Run the river.
    Was this article helpful?
    What's Next