JSM Functional Specification Documentation and Logical Flow Diagrams

[Graham Tyrie]

Hi all.  I have been tasked to document the configuration of our project in JSM - documenting workflows / automation etc. for change management reasons.  I know this question has already been asked but I don't think there has been a full response.  Is there a way of reporting on a project to identify config. settings (automation/workflows/queues) with out having to download a 3rd part app such as Smart Jira Configuration as this would be a lengthy governance process in the industry I work in from a security perspective to get such an app installed on our servers.  I am not talking server settings/data import/export, but functional configuration settings.

If there is no way of viewing/exporting project/workflows/automation settings, is there a logical diagram anywhere which maps the functional relationships between Projects/Forms/Automation/Workflows/work queues which would support me in manually documenting the portal config. settings so I can create a functional configuration document for change management purposes?  The end result being that I will publish to Confluence so that if any changes are made to the project, the documentation can be updated by whoever makes the change.

Your help is appreciated.

[Nic Brough -Adaptavist- · Accepted solution]

Welcome to the Atlassian Community!

The very short answer is "no".  

As you say, there are apps that can give you a view of some of the configuration, but without them, your only option is to plough through all the project settings and note what they are.  Even the apps that report on settings don't really tell you everything, they all focus on specific aspects of the configuration that are related to what the app is for.

This is partly because the configuration of a project is not done in one place, and nor is it done in plain human languages.  If you want to document a workflow, then your best bet is to open up the view or edit page for the workflow, take a screenshot of the diagram, and then go in to edit mode to look through all the conditions, validators, post-functions, and triggers that have been added to it.  While bearing in mind that the workflow is not a project configuration thing for company-managed projects.  They're global and could be shared.  That's the same for automations, scripts, apps, and fields - you'll need to look at their configurations globally to see what projects they are configured for.

[Graham Tyrie]

Thanks, I really appreciate your answer.  Does Atlassian have any diagrams/documentation which explains the relationship between Projects/Workfows/automations (class diagrams/logical diagrams etc.) so that I can understand the relationships when I come to pulling out the config. for documenting?

[Nic Brough -Adaptavist-]

Not that I can find, no.  I don't think there's a lot of use for diagrams, they would not help very much.

Using the objects you've mentioned (which are only some of the configuration items you probably want to think about)

Workflows are tied to company-managed projects via the workflow scheme which tells the project which workflow to use for each issue type in the project

Workflows in team-managed projects are defined by the issue type in the project configuration

Automations can be global or belong to a project, and can be configured to work with many projects.  You have to look at the Automation to see where it is going to be active, there's no direct relationship with a project

The diagrams you're thinking of would be very simple and look like

• Workflow <> Project (via scheme)
• Workflow <> Project (via issue config)
• Automation <> Project(s) (via Automation config)

and so on.

[Graham Tyrie]

Thanks Nic

[Graham Tyrie]

Hi, rather than ask a new question, I thought I would resurrect this one again.  I am in the process of documenting the config of our project within JSM, and as such I am starting to understand the relationship between the different services (Workflows/Issues/Forms etc. etc.).  I want to document these relationships in a logical diagram to make it more visual to the reader.

There must be a diagram that explains these relationships, whether that be a formal class diagram which explains the CDMS schema of a logical diagram / entity relationship diagram or use case showing the inter-relationships?  I find it hard to believe that these types of artefacts were not generated by DevOps etc?  Perhaps I should be escalating this to 'Support' rather than via the 'Community'?

Your help is appreciated.